Merge branch 'MichaelSpece-codex/signed-out-account-preferences'

Author: veloce

lib/src/model/account/account_preferences.dart

@@ -1,51 +1,58 @@
+import 'dart:convert';
+
 import 'package:fast_immutable_collections/fast_immutable_collections.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:freezed_annotation/freezed_annotation.dart';
 import 'package:lichess_mobile/l10n/l10n.dart';
+import 'package:lichess_mobile/src/binding.dart';
 import 'package:lichess_mobile/src/model/account/account_repository.dart';
 import 'package:lichess_mobile/src/model/auth/auth_controller.dart';
+import 'package:lichess_mobile/src/model/settings/preferences_storage.dart';
 
-typedef AccountPrefState = ({
-  // game display
-  Zen zenMode,
-  PieceNotation pieceNotation,
-  ShowRatings showRatings,
-  // game behavior
-  BooleanPref premove,
-  AutoQueen autoQueen,
-  AutoThreefold autoThreefold,
-  Takeback takeback,
-  BooleanPref confirmResign,
-  SubmitMove submitMove,
-  // clock
-  Moretime moretime,
-  ClockTenths clockTenths,
-  BooleanPref clockSound,
-  // privacy
-  BooleanPref follow,
-  Challenge challenge,
-  Message message,
-});
-
-/// A provider that tells if the user wants to see ratings in the app.
-final showRatingsPrefProvider = FutureProvider<ShowRatings>((Ref ref) async {
-  final prefs = await ref.watch(accountPreferencesProvider.future);
-  return prefs?.showRatings ?? defaultAccountPreferences.showRatings;
-});
+part 'account_preferences.freezed.dart';
+part 'account_preferences.g.dart';
 
-/// A provider that tells if the user wants clock sounds.
-final clockSoundProvider = FutureProvider<bool>((Ref ref) async {
-  final prefs = await ref.watch(accountPreferencesProvider.future);
-  return prefs?.clockSound.value ?? defaultAccountPreferences.clockSound.value;
-});
-
-/// A provider that gives the user's preferred piece notation.
-final pieceNotationProvider = FutureProvider<PieceNotation>((Ref ref) async {
-  final prefs = await ref.watch(accountPreferencesProvider.future);
-  return prefs?.pieceNotation ?? defaultAccountPreferences.pieceNotation;
-});
+/// Represents the account preferences for a user.
+///
+/// If the user is authenticated, the preferences are fetched from the server. If the user is not authenticated, the preferences are fetched from local storage.
+/// Technically an anonymous user does not have account preferences, but we still store them locally for convenience, because some settings are useful even for anonymous users (e.g. piece notation, premoves, etc.).
+@Freezed(fromJson: true, toJson: true)
+sealed class AccountPrefState with _$AccountPrefState implements Serializable {
+  const AccountPrefState._();
+
+  const factory AccountPrefState({
+    // game display
+    @JsonKey(unknownEnumValue: Zen.no) required Zen zenMode,
+    @JsonKey(unknownEnumValue: PieceNotation.symbol) required PieceNotation pieceNotation,
+    @JsonKey(unknownEnumValue: ShowRatings.yes) required ShowRatings showRatings,
+    // game behavior
+    required BooleanPref premove,
+    @JsonKey(unknownEnumValue: AutoQueen.premove) required AutoQueen autoQueen,
+    @JsonKey(unknownEnumValue: AutoThreefold.always) required AutoThreefold autoThreefold,
+    @JsonKey(unknownEnumValue: Takeback.always) required Takeback takeback,
+    required BooleanPref confirmResign,
+    required SubmitMove submitMove,
+    // clock
+    @JsonKey(unknownEnumValue: Moretime.always) required Moretime moretime,
+    @JsonKey(unknownEnumValue: ClockTenths.lessThan10s) required ClockTenths clockTenths,
+    required BooleanPref clockSound,
+    // privacy
+    required BooleanPref follow,
+    @JsonKey(unknownEnumValue: Challenge.registered) required Challenge challenge,
+    @JsonKey(unknownEnumValue: Message.always) required Message message,
+  }) = _AccountPrefState;
+
+  factory AccountPrefState.fromJson(Map<String, dynamic> json) {
+    try {
+      return _$AccountPrefStateFromJson(json);
+    } catch (_) {
+      return defaultAccountPreferences;
+    }
+  }
+}
 
-final defaultAccountPreferences = (
+final defaultAccountPreferences = AccountPrefState(
   zenMode: Zen.no,
   pieceNotation: PieceNotation.symbol,
   showRatings: ShowRatings.yes,
@@ -63,8 +70,32 @@ final defaultAccountPreferences = (
   message: Message.always,
 );
 
+/// A provider that tells if the user wants to see ratings in the app.
+final showRatingsPrefProvider = FutureProvider<ShowRatings>((Ref ref) async {
+  final prefs = await ref.watch(accountPreferencesProvider.future);
+  return prefs.showRatings;
+});
+
+/// A provider that tells if the user wants clock sounds.
+final clockSoundProvider = FutureProvider<bool>((Ref ref) async {
+  final prefs = await ref.watch(accountPreferencesProvider.future);
+  return prefs.clockSound.value;
+});
+
+/// A provider that gives the user's preferred piece notation.
+final pieceNotationProvider = FutureProvider<PieceNotation>((Ref ref) async {
+  final prefs = await ref.watch(accountPreferencesProvider.future);
+  return prefs.pieceNotation;
+});
+
+/// A provider that gives the user's preferred clock tenths display.
+final clockTenthsProvider = FutureProvider<ClockTenths>((Ref ref) async {
+  final prefs = await ref.watch(accountPreferencesProvider.future);
+  return prefs.clockTenths;
+});
+
 /// A provider that gives the account preferences for the current user.
-final accountPreferencesProvider = AsyncNotifierProvider<AccountPreferences, AccountPrefState?>(
+final accountPreferencesProvider = AsyncNotifierProvider<AccountPreferences, AccountPrefState>(
   AccountPreferences.new,
   name: 'AccountPreferencesProvider',
 );
@@ -73,45 +104,99 @@ final accountPreferencesProvider = AsyncNotifierProvider<AccountPreferences, Acc
 ///
 /// The result is cached for the lifetime of the app, until refreshed.
 /// If the server returns an error, default values are returned.
-class AccountPreferences extends AsyncNotifier<AccountPrefState?> {
+///
+/// If the user is authenticated, the preferences are fetched from the server. If the user is not authenticated, the preferences are fetched from local storage.
+/// See also [AccountPrefState] for more details.
+class AccountPreferences extends AsyncNotifier<AccountPrefState> {
   @override
-  Future<AccountPrefState?> build() async {
+  Future<AccountPrefState> build() async {
     final authUser = ref.watch(authControllerProvider);
 
     if (authUser == null) {
-      return null;
+      return _fetchLocal();
     }
 
     try {
-      return ref.read(accountRepositoryProvider).getPreferences();
+      return await ref.read(accountRepositoryProvider).getPreferences();
     } catch (e) {
       debugPrint('[AccountPreferences] Error getting account preferences: $e');
       return defaultAccountPreferences;
     }
   }
 
-  Future<void> setZen(Zen value) => _setPref('zen', value);
-  Future<void> setPieceNotation(PieceNotation value) => _setPref('pieceNotation', value);
-  Future<void> setShowRatings(ShowRatings value) => _setPref('ratings', value);
-
-  Future<void> setPremove(BooleanPref value) => _setPref('premove', value);
-  Future<void> setTakeback(Takeback value) => _setPref('takeback', value);
-  Future<void> setAutoQueen(AutoQueen value) => _setPref('autoQueen', value);
-  Future<void> setAutoThreefold(AutoThreefold value) => _setPref('autoThreefold', value);
-  Future<void> setMoretime(Moretime value) => _setPref('moretime', value);
-  Future<void> setClockTenths(ClockTenths value) => _setPref('clockTenths', value);
-  Future<void> setClockSound(BooleanPref value) => _setPref('clockSound', value);
-  Future<void> setConfirmResign(BooleanPref value) => _setPref('confirmResign', value);
-  Future<void> setSubmitMove(SubmitMove value) => _setPref('submitMove', value);
-  Future<void> setFollow(BooleanPref value) => _setPref('follow', value);
-  Future<void> setChallenge(Challenge value) => _setPref('challenge', value);
-  Future<void> setMessage(Message value) => _setPref('message', value);
-
-  Future<void> _setPref<T>(String key, AccountPref<T> value) async {
+  Future<void> setZen(Zen value) =>
+      _setPref('zen', value, (prefs) => prefs.copyWith(zenMode: value));
+  Future<void> setPieceNotation(PieceNotation value) =>
+      _setPref('pieceNotation', value, (prefs) => prefs.copyWith(pieceNotation: value));
+  Future<void> setShowRatings(ShowRatings value) =>
+      _setPref('ratings', value, (prefs) => prefs.copyWith(showRatings: value));
+
+  Future<void> setPremove(BooleanPref value) =>
+      _setPref('premove', value, (prefs) => prefs.copyWith(premove: value));
+  Future<void> setTakeback(Takeback value) =>
+      _setPref('takeback', value, (prefs) => prefs.copyWith(takeback: value));
+  Future<void> setAutoQueen(AutoQueen value) =>
+      _setPref('autoQueen', value, (prefs) => prefs.copyWith(autoQueen: value));
+  Future<void> setAutoThreefold(AutoThreefold value) =>
+      _setPref('autoThreefold', value, (prefs) => prefs.copyWith(autoThreefold: value));
+  Future<void> setMoretime(Moretime value) =>
+      _setPref('moretime', value, (prefs) => prefs.copyWith(moretime: value));
+  Future<void> setClockTenths(ClockTenths value) =>
+      _setPref('clockTenths', value, (prefs) => prefs.copyWith(clockTenths: value));
+  Future<void> setClockSound(BooleanPref value) =>
+      _setPref('clockSound', value, (prefs) => prefs.copyWith(clockSound: value));
+  Future<void> setConfirmResign(BooleanPref value) =>
+      _setPref('confirmResign', value, (prefs) => prefs.copyWith(confirmResign: value));
+  Future<void> setSubmitMove(SubmitMove value) =>
+      _setPref('submitMove', value, (prefs) => prefs.copyWith(submitMove: value));
+  Future<void> setFollow(BooleanPref value) =>
+      _setPref('follow', value, (prefs) => prefs.copyWith(follow: value));
+  Future<void> setChallenge(Challenge value) =>
+      _setPref('challenge', value, (prefs) => prefs.copyWith(challenge: value));
+  Future<void> setMessage(Message value) =>
+      _setPref('message', value, (prefs) => prefs.copyWith(message: value));
+
+  Future<void> _setPref<T>(
+    String key,
+    AccountPref<T> value,
+    AccountPrefState Function(AccountPrefState prefs) updateLocal,
+  ) async {
+    final authUser = ref.read(authControllerProvider);
+    if (authUser == null) {
+      await _saveLocal(updateLocal(state.value ?? _fetchLocal()));
+      return;
+    }
+
     await Future<void>.delayed(const Duration(milliseconds: 200));
     await ref.read(accountRepositoryProvider).setPreference(key, value);
     ref.invalidateSelf();
   }
+
+  Future<void> _saveLocal(AccountPrefState value) async {
+    await LichessBinding.instance.sharedPreferences.setString(
+      PrefCategory.account.storageKey,
+      jsonEncode(value.toJson()),
+    );
+
+    if (!ref.mounted) return;
+
+    state = AsyncValue.data(value);
+  }
+
+  AccountPrefState _fetchLocal() {
+    final stored = LichessBinding.instance.sharedPreferences.getString(
+      PrefCategory.account.storageKey,
+    );
+    if (stored == null) {
+      return defaultAccountPreferences;
+    }
+    try {
+      return AccountPrefState.fromJson(jsonDecode(stored) as Map<String, dynamic>);
+    } catch (e) {
+      debugPrint('[AccountPreferences] Error reading local account preferences: $e');
+      return defaultAccountPreferences;
+    }
+  }
 }
 
 abstract class AccountPref<T> {
@@ -128,6 +213,10 @@ class BooleanPref implements AccountPref<bool> {
   @override
   String get toFormData => value ? '1' : '0';
 
+  factory BooleanPref.fromJson(bool json) => BooleanPref(json);
+
+  bool toJson() => value;
+
   static BooleanPref fromInt(int value) {
     switch (value) {
       case 1:
@@ -141,8 +230,11 @@ class BooleanPref implements AccountPref<bool> {
 }
 
 enum Zen implements AccountPref<int> {
+  @JsonValue(0)
   no(0),
+  @JsonValue(1)
   yes(1),
+  @JsonValue(2)
   gameAuto(2);
 
   const Zen(this.value);
@@ -179,8 +271,11 @@ enum Zen implements AccountPref<int> {
 }
 
 enum ShowRatings implements AccountPref<int> {
+  @JsonValue(0)
   no(0),
+  @JsonValue(1)
   yes(1),
+  @JsonValue(2)
   exceptInGame(2);
 
   const ShowRatings(this.value);
@@ -217,7 +312,9 @@ enum ShowRatings implements AccountPref<int> {
 }
 
 enum PieceNotation implements AccountPref<int> {
+  @JsonValue(0)
   symbol(0),
+  @JsonValue(1)
   letter(1);
 
   const PieceNotation(this.value);
@@ -250,8 +347,11 @@ enum PieceNotation implements AccountPref<int> {
 }
 
 enum AutoQueen implements AccountPref<int> {
+  @JsonValue(1)
   never(1),
+  @JsonValue(2)
   premove(2),
+  @JsonValue(3)
   always(3);
 
   const AutoQueen(this.value);
@@ -288,8 +388,11 @@ enum AutoQueen implements AccountPref<int> {
 }
 
 enum AutoThreefold implements AccountPref<int> {
+  @JsonValue(1)
   never(1),
+  @JsonValue(2)
   time(2),
+  @JsonValue(3)
   always(3);
 
   const AutoThreefold(this.value);
@@ -326,8 +429,11 @@ enum AutoThreefold implements AccountPref<int> {
 }
 
 enum Takeback implements AccountPref<int> {
+  @JsonValue(1)
   never(1),
+  @JsonValue(2)
   casual(2),
+  @JsonValue(3)
   always(3);
 
   const Takeback(this.value);
@@ -364,8 +470,11 @@ enum Takeback implements AccountPref<int> {
 }
 
 enum Moretime implements AccountPref<int> {
+  @JsonValue(1)
   never(1),
+  @JsonValue(2)
   casual(2),
+  @JsonValue(3)
   always(3);
 
   const Moretime(this.value);
@@ -402,8 +511,11 @@ enum Moretime implements AccountPref<int> {
 }
 
 enum ClockTenths implements AccountPref<int> {
+  @JsonValue(0)
   never(0),
+  @JsonValue(1)
   lessThan10s(1),
+  @JsonValue(2)
   always(2);
 
   const ClockTenths(this.value);
@@ -440,10 +552,15 @@ enum ClockTenths implements AccountPref<int> {
 }
 
 enum Challenge implements AccountPref<int> {
+  @JsonValue(1)
   never(1),
+  @JsonValue(2)
   rating(2),
+  @JsonValue(3)
   friends(3),
+  @JsonValue(4)
   registered(4),
+  @JsonValue(5)
   always(5);
 
   const Challenge(this.value);
@@ -488,8 +605,11 @@ enum Challenge implements AccountPref<int> {
 }
 
 enum Message implements AccountPref<int> {
+  @JsonValue(1)
   never(1),
+  @JsonValue(2)
   friends(2),
+  @JsonValue(3)
   always(3);
 
   const Message(this.value);
@@ -546,6 +666,10 @@ class SubmitMove implements AccountPref<int> {
 
   factory SubmitMove.fromInt(int value) =>
       SubmitMove(SubmitMoveChoice.values.where((choice) => _bitPresent(value, choice.value)));
+
+  factory SubmitMove.fromJson(int json) => SubmitMove.fromInt(json);
+
+  int toJson() => value;
 }
 
 enum SubmitMoveChoice {