Everything is provider

[bannzai]

Abstract

Riverpod をフル活用する方向に修正する。具体的には

• AsyncValueの採用。AsyncValue を Widget側でも使用して state.when(data:error:loading) の機能を使用する
• Streamを基本的に使用する。Datastoreに生えていたfetch系のメソッドは基本使わない
  • Streamが統一されることでコードの統一感と、重複して同じ内容のStreamが存在しないようにする
• StateNotifier内部でStateを作っていたが、外部でStateをProvider経由で用意する。そしてStateNotifierにはinitialStateとして外から渡すようにした。外のProvider(() => State)に変更があればStateNotifier自体も再生成される
• Datastoreのmutate系のメソッドをAsyncActionとして切り出す。これによりStateNotifierへの不要なDatastoreのDIを無くす。AsyncActionのテストをしたかったら別途AsyncActionのインスタンスを作るだけにする

Code

State

FutureProvider,StreamProviderをwatchして、変更があればStateが更新される。読み込み中はwatchした内容がAsyncLoadingの場合は AsyncLoadingを返す。そうでない場合はvalueを取得する。value取得時にエラーの場合はエラーがthrowされるのでtry,catchをする

final settingStateProvider = Provider<AsyncValue<SettingState>>((ref) {
  final latestPillSheetGroup = ref.watch(latestPillSheetGroupStreamProvider);
  final premiumAndTrial = ref.watch(premiumAndTrialProvider);
  final setting = ref.watch(settingStreamProvider);
  final sharedPreferencesAsyncValue = ref.watch(sharedPreferenceProvider);
  final isHealthDataAvailable = ref.watch(isHealthDataAvailableProvider);

  if (latestPillSheetGroup is AsyncLoading ||
      premiumAndTrial is AsyncLoading ||
      setting is AsyncLoading ||
      sharedPreferencesAsyncValue is AsyncLoading ||
      isHealthDataAvailable is AsyncLoading) {
    return const AsyncValue.loading();
  }

  try {
    final sharedPreferences = sharedPreferencesAsyncValue.value!;
    final userIsMigratedFrom132 =
        sharedPreferences.containsKey(StringKey.salvagedOldStartTakenDate) &&
            sharedPreferences.containsKey(StringKey.salvagedOldLastTakenDate);

    return AsyncValue.data(
      SettingState(
        latestPillSheetGroup: latestPillSheetGroup.value!,
        setting: setting.value!,
        premiumAndTrial: premiumAndTrial.value!,
        isHealthDataAvailable: isHealthDataAvailable.value!,
        userIsUpdatedFrom132: userIsMigratedFrom132,
      )
    );
  } catch (error, stacktrace) {
    return AsyncValue.error(error, stackTrace: stacktrace);
  }
});

StateNotifier

StateNotifierはStateの変更により作り直される。なので、作り直された前と後で変更点以外は生合成が合うように気をつける必要がある

final settingStateNotifierProvider =
    StateNotifierProvider<SettingStateNotifier, AsyncValue<SettingState>>(
  (ref) => SettingStateNotifier(
    asyncAction: ref.watch(settingPageAsyncActionProvider),
    initialState: ref.watch(settingStateProvider),
  ),
);

class SettingStateNotifier extends StateNotifier<AsyncValue<SettingState>> {
  final SettingPageAsyncAction asyncAction;
  SettingStateNotifier({
    required this.asyncAction,
    required AsyncValue<SettingState> initialState,
  }) : super(initialState);
}

Widget

class SettingPage extends HookConsumerWidget {
  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final store = ref.watch(settingStateNotifierProvider.notifier);
    final state = ref.watch(settingStateNotifierProvider);

    useAutomaticKeepAlive(wantKeepAlive: true);

    return state.when(
      data: (state) => SettingPageBody(store: store, state: state),
      error: (error, _) => UniversalErrorPage(
        error: error,
        child: null,
        reload: () => ref.refresh(settingStateProvider),
      ),
      loading: () => ScaffoldIndicator(),
    );
  }
}

Checked

• Analyticsのログを入れたか
• 境界値に対してのUnitTestを書いた
• パターン分岐が発生するWidgetに対してWidgetTestを書いた
• リリースノートを追加した