【Flutter/Riverpod】Generatorで自動生成した(Async)NotifierProviderをoverrideWithで上書き

表題のやり方をピンポイントに解説した日本語情報が見つけられなかった（探し方が悪いだけかもしれませんが）ので記事にしておきます。

## 環境

```console:$ flutter doctor
[√] Flutter (Channel stable, 3.29.1, on Microsoft Windows [Version 10.0.26100.3775], locale ja-JP)
[√] Windows Version (11 Pro 64-bit, 24H2, 2009)
[√] Android toolchain - develop for Android devices (Android SDK version 35.0.1)
[X] Chrome - develop for the web (Cannot find Chrome executable at .\Google\Chrome\Application\chrome.exe)
    ! Cannot find Chrome. Try setting CHROME_EXECUTABLE to a Chrome executable.
[√] Visual Studio - develop Windows apps (Visual Studio Community 2022 17.13.3)
[√] Android Studio (version 2024.3)
[√] VS Code (version 1.99.3)
[√] Connected device (2 available)
[√] Network resources
```

> 執筆時点ではChromeは入れてないです（常用ブラウザがChromeでないことと、Webアプリは開発スコープに含めてないこと以外に特段の理由はありません）

```yaml:pubspec.yaml（抜粋）
  flutter_riverpod: ^2.6.1
  riverpod_annotation: ^2.6.1

dev_dependencies:
  build_runner: ^2.4.13
  test: ^1.25.7
  riverpod_generator: ^2.6.4
```

## とりあえず (Async)NotifierProvider を overrideWith

なかなか情報が見つけられず、正しい書き方を見つけるまで四苦八苦しましたが
英語の情報も当たってみたら下記に辿り着いたのでこれに即してやってみたら上手くいきました。

https://stackoverflow.com/questions/75696349/how-do-you-correctly-override-an-auto-generated-riverpod-notifierprovider-for-te

```dart:コード例　test.dart
import 'package:flutter_test/flutter_test.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';

part 'test.g.dart';

// プロダクトの（本物の）Provider
@riverpod
class TheNumber extends _$TheNumber {
  @override
  int build() => 0;

  void set(int num) => state = num;
}

// 上記プロバイダを参照しているTheNumberServiceクラス（非ウィジェット）・
// TheNumberWidgetクラス があるものとします（実装省略）

// theNumberProviderを上書きする用のクラス（以下「上書きクラス」）
@riverpod
class TheNumberStub extends _$TheNumberStub implements TheNumber {
  @override
  int build() => 42;  // 常時固定の値とする

  // implements TheNumber しているので TheNumber クラスの全メンバ・全メソッドの @override が必須
  @override
  void set(int num) => ();
}

// テストコード
void main() {
  test('TheNumberService クラスのテスト', () {
    final container = ProviderContainer(overrides: [
      repositoryProvider.overrideWith(() => TheNumberStub()),
    ]);

    final service = TheNumberService();
    // service についての各種検証：expect(...)

    container.dispose();
  });

  testWidgets('TheNumberWidget のウィジェットテスト', (tester) async {
    await tester.pumpWidget(ProviderScope(overrides: [
      repositoryProvider.overrideWith(() => TheNumberStub()),
    ], child: const TheNumberWidget()));

    // Widget についての各種検証：expect(find. ... , findsNothing/findsOneWidget/...)
  });
}
```

上書きクラスは下記のように元の `TheNumber` クラスを直接 `extends` しても動きました。
この場合 `build` はやはり `@override` 必須ですが、それ以外で挙動を特に変える必要がないメソッドやメンバは `@override` しなくても大丈夫です。

```diff_dart
  @riverpod
- class TheNumberStub extends _$TheNumberStub implements TheNumber {
+ class TheNumberStub extends TheNumber {
    @override
    int build() => 42;
-
-   @override
-   void set(int num) => ();
  }
```

AsyncNotifierProvider でも、いずれの方法で上書きクラスを実装しても NotifierProvider の場合と全く同様に動かせました。


## （少々逸脱）モック？ スタブ？ フェイク？

ここまで `overrideWith` で上書きする用のクラスを敢えて本記事独自の呼称で濁した書き方をしてきましたが、言わずもがな上書きを行う動機は十中八九テストコードで本当のオブジェクトの代わりをさせるためかと思います。
要は**モック**のことね、と思った方は本節も一読した方がいいかもしれません。**スタブ**（ないし**テストダブル**）のことね、と思った方は本節には恐らくご存知のことしか書いてませんので読み飛ばしてください。

その「本当のオブジェクトの代わり」をするもののことを一概に「**モック**」と言いがち[^1]ですが、実際には「**モック**」というのはそのうちのある種のもののみを指しているに過ぎず、総称としては「**テストダブル**」と呼ぶのが正しいそうです。
では具体的にどうだったら「**モック**」なのか、「**モック**」ではないテストダブル（**スタブ**や**フェイク**など）はどうだったらどれなのか――は本旨から外れるので詳細は割愛します（解説記事もちょっと探せば多数見つかります）が、数多の記事（勿論全ては読んでませんが）中で個人的に分かりやすかったものを下記に紹介しておきます。

https://it-infomation.com/test-double-stub-spy-mock-fake-dummy/

https://zenn.dev/takamin55/articles/3b0c52bee37782

で、これを踏まえた上でここまで「上書きクラス」と呼んでいたものは正しくは何なのか、という話ですが
少なくともテスト対象クラス・ウィジェットが上書きクラスをどう呼び出したかの検証[^2]は不可能なので「**モック**」ではありません。
Generator での生成により Provider の機能を一通り持っているという意味では「**フェイク**」のような側面もなくはないかもですが、
役割としては `state` の値を固定しテスト対象に間接入力を与えるだけなので「**スタブ**」であると考えられます[^3]。


## モックで overrideWith

(Async)NotifierProvider を（手製の）**スタブ** で `overrideWith` するなら以上で問題ないですが、`verify` も行うために（本当の意味での）**モック** で行うにはどうすればよいのでしょうか。
`verify` の必要もあるなら Mockito 等で自動生成したモッククラスで `overrideWith` したい、となるのが人情(??)ですが、残念ながらそれは**不可能**なようです。

https://github.com/rrousselGit/riverpod/discussions/2595

https://dev.classmethod.jp/articles/flutter-riverpod-widget-test/#toc-4

双方とも当初 Mockito で生成したモッククラスでの `overrideWith` を試みたものの上手くいかず[^4]、モッククラスも(半)手製で作ることでどうにか達成できた様子。
本記事執筆時はスタブの挙動で十分だったのでこちらは実際に試しておらず、そのためサンプルコードも書いていませんのでモック化まで必要な方はこれらをご参考に願います。


## 公式見解（そもそも論）

(Async)NotifierProvider のモック化はそもそも非推奨で、代わりにその依存先をモック化すべきと Riverpod のドキュメントには書いてありました：

https://riverpod.dev/ja/docs/essentials/testing#notifiers-%E3%81%AE%E3%83%A2%E3%83%83%E3%82%AF

でもそうは言っても、モック化まではともかくとしてもスタブ化、即ち (Async)NotifierProvider のメソッドに決まった値を返させたいときはありますよねえ[^5]。
そういう場面にぶつかった際 本記事がお役に立てば、ということで。


## その他参考情報

https://stackoverflow.com/questions/79007775/i-dont-know-how-to-mock-riverpods-provider-with-mockito

https://github.com/rrousselGit/riverpod/discussions/2514


[^1]: そして筆者自身も本記事を書き始めた時点ではそうだった（今回初めてきちんと勉強・理解した）ので当初「モック」で書き通しかけた
[^2]: Mockito 等でいうところの `verify`
[^3]: そのため参考記事を基に書いたコードサンプルでも「`Fake～`」は「`～Stub`」にした
[^4]: リンク先にあるようなコンパイルエラーも出るし、(Async)NotifierProvider から自動生成したモックに対し実際に `when` で挙動を定義しようとすると `state` がスコープ外で操作できないことからも一筋縄に行かないのが分かる
[^5]: DIをコンストラクタ引数で実現していればスタブで `overrideWith` する必要もないという見解もあるかもしれないが、Riverpod を最大限活用するならDIも `overrideWith` で実現したいかなと