Bookmark games

lib/src/model/auth/auth_session.dart

@@ -1,3 +1,4 @@
+import 'package:flutter_riverpod/flutter_riverpod.dart';
 import 'package:freezed_annotation/freezed_annotation.dart';
 import 'package:lichess_mobile/src/model/auth/session_storage.dart';
 import 'package:lichess_mobile/src/model/common/preloaded_data.dart';
@@ -34,3 +35,8 @@ class AuthSessionState with _$AuthSessionState {
 
   factory AuthSessionState.fromJson(Map<String, dynamic> json) => _$AuthSessionStateFromJson(json);
 }
+
+@riverpod
+bool isLoggedIn(Ref ref) {
+  return ref.watch(authSessionProvider.select((authSession) => authSession != null));
+}

lib/src/model/game/archived_game.dart

@@ -57,8 +57,8 @@ class ArchivedGame with _$ArchivedGame, BaseGame, IndexableSteps implements Base
   ///
   /// Currently, those endpoints are supported:
   /// - GET /game/export/<id>
-  factory ArchivedGame.fromServerJson(Map<String, dynamic> json) {
-    return _archivedGameFromPick(pick(json).required());
+  factory ArchivedGame.fromServerJson(Map<String, dynamic> json, {bool withBookmarked = false}) {
+    return _archivedGameFromPick(pick(json).required(), withBookmarked: withBookmarked);
   }
 
   /// Create an archived game from a local storage JSON.
@@ -99,10 +99,14 @@ class LightArchivedGame with _$LightArchivedGame {
     @MoveConverter() Move? lastMove,
     Side? winner,
     ClockData? clock,
+    bool? bookmarked,
   }) = _ArchivedGameData;
 
-  factory LightArchivedGame.fromServerJson(Map<String, dynamic> json) {
-    return _lightArchivedGameFromPick(pick(json).required());
+  factory LightArchivedGame.fromServerJson(
+    Map<String, dynamic> json, {
+    bool withBookmarked = false,
+  }) {
+    return _lightArchivedGameFromPick(pick(json).required(), withBookmarked: withBookmarked);
   }
 
   factory LightArchivedGame.fromJson(Map<String, dynamic> json) =>
@@ -129,8 +133,8 @@ IList<ExternalEval>? gameEvalsFromPick(RequiredPick pick) {
       ?.lock;
 }
 
-ArchivedGame _archivedGameFromPick(RequiredPick pick) {
-  final data = _lightArchivedGameFromPick(pick);
+ArchivedGame _archivedGameFromPick(RequiredPick pick, {bool withBookmarked = false}) {
+  final data = _lightArchivedGameFromPick(pick, withBookmarked: withBookmarked);
   final clocks = pick(
     'clocks',
   ).asListOrNull<Duration>((p0) => Duration(milliseconds: p0.asIntOrThrow() * 10));
@@ -202,7 +206,7 @@ ArchivedGame _archivedGameFromPick(RequiredPick pick) {
   );
 }
 
-LightArchivedGame _lightArchivedGameFromPick(RequiredPick pick) {
+LightArchivedGame _lightArchivedGameFromPick(RequiredPick pick, {bool withBookmarked = false}) {
   return LightArchivedGame(
     id: pick('id').asGameIdOrThrow(),
     fullId: pick('fullId').asGameFullIdOrNull(),
@@ -223,6 +227,7 @@ LightArchivedGame _lightArchivedGameFromPick(RequiredPick pick) {
     lastMove: pick('lastMove').asUciMoveOrNull(),
     clock: pick('clock').letOrNull(_clockDataFromPick),
     opening: pick('opening').letOrNull(_openingFromPick),
+    bookmarked: withBookmarked ? pick('bookmarked').asBoolOrFalse() : null,
   );
 }
 

lib/src/model/game/game_bookmark_provider.dart

@@ -0,0 +1,14 @@
+import 'package:lichess_mobile/src/model/common/id.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'game_bookmark_provider.g.dart';
+
+/// A provider to store the bookmark value of a game when it was changed by the user.
+@Riverpod(keepAlive: true)
+class GameBookmark extends _$GameBookmark {
+  @override
+  bool? build(GameId id) => null;
+
+  @override
+  set state(bool? newState) => super.state = newState;
+}

lib/src/model/game/game_history.dart

@@ -61,7 +61,7 @@ Future<IList<LightArchivedGameWithPov>> myRecentGames(Ref ref) async {
 @riverpod
 Future<IList<LightArchivedGameWithPov>> userRecentGames(Ref ref, {required UserId userId}) {
   return ref.withClientCacheFor(
-    (client) => GameRepository(client).getUserGames(userId),
+    (client) => GameRepository(client).getUserGames(userId, withBookmarked: true),
     // cache is important because the associated widget is in a [ListView] and
     // the provider may be instanciated multiple times in a short period of time
     // (e.g. when scrolling)
@@ -119,7 +119,10 @@ class UserGameHistory extends _$UserGameHistory {
     final id = userId ?? session?.user.id;
     final recentGames =
         id != null && online
-            ? ref.withClient((client) => GameRepository(client).getUserGames(id, filter: filter))
+            ? ref.withClient(
+              (client) =>
+                  GameRepository(client).getUserGames(id, filter: filter, withBookmarked: true),
+            )
             : storage
                 .page(userId: id, filter: filter)
                 .then(
@@ -158,6 +161,7 @@ class UserGameHistory extends _$UserGameHistory {
               max: _nbPerPage,
               until: _list.last.game.createdAt,
               filter: currentVal.filter,
+              withBookmarked: true,
             ),
           )
           : currentVal.online && currentVal.session != null
@@ -167,6 +171,7 @@ class UserGameHistory extends _$UserGameHistory {
               max: _nbPerPage,
               until: _list.last.game.createdAt,
               filter: currentVal.filter,
+              withBookmarked: true,
             ),
           )
           : (await ref.watch(gameStorageProvider.future))

lib/src/model/game/game_repository.dart

@@ -13,11 +13,18 @@ class GameRepository {
 
   final LichessClient client;
 
-  Future<ArchivedGame> getGame(GameId id) {
+  Future<ArchivedGame> getGame(GameId id, {bool withBookmarked = false}) {
     return client.readJson(
-      Uri(path: '/game/export/$id', queryParameters: {'clocks': '1', 'accuracy': '1'}),
+      Uri(
+        path: '/game/export/$id',
+        queryParameters: {
+          'clocks': '1',
+          'accuracy': '1',
+          if (withBookmarked) 'withBookmarked': '1',
+        },
+      ),
       headers: {'Accept': 'application/json'},
-      mapper: ArchivedGame.fromServerJson,
+      mapper: (json) => ArchivedGame.fromServerJson(json, withBookmarked: withBookmarked),
     );
   }
 
@@ -34,6 +41,7 @@ class GameRepository {
     int max = 20,
     DateTime? until,
     GameFilterState filter = const GameFilterState(),
+    bool withBookmarked = false,
   }) {
     assert(!filter.perfs.contains(Perf.fromPosition));
     assert(!filter.perfs.contains(Perf.puzzle));
@@ -53,10 +61,11 @@ class GameRepository {
               if (filter.perfs.isNotEmpty)
                 'perfType': filter.perfs.map((perf) => perf.name).join(','),
               if (filter.side != null) 'color': filter.side!.name,
+              if (withBookmarked) 'withBookmarked': 'true',
             },
           ),
           headers: {'Accept': 'application/x-ndjson'},
-          mapper: LightArchivedGame.fromServerJson,
+          mapper: (json) => LightArchivedGame.fromServerJson(json, withBookmarked: withBookmarked),
         )
         .then(
           (value) =>
@@ -91,4 +100,13 @@ class GameRepository {
       mapper: LightArchivedGame.fromServerJson,
     );
   }
+
+  /// Bookmark the game for the given `id` if `bookmark` is true else unbookmark it
+  Future<void> bookmark(GameId id, {required bool bookmark}) async {
+    final uri = Uri(path: '/bookmark/$id', queryParameters: {'v': bookmark ? '1' : '0'});
+    final response = await client.post(uri);
+    if (response.statusCode >= 400) {
+      throw http.ClientException('Failed to bookmark game: ${response.statusCode}', uri);
+    }
+  }
 }

lib/src/model/game/game_repository_providers.dart

@@ -1,5 +1,6 @@
 import 'package:fast_immutable_collections/fast_immutable_collections.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:lichess_mobile/src/model/auth/auth_session.dart';
 import 'package:lichess_mobile/src/model/common/id.dart';
 import 'package:lichess_mobile/src/model/game/archived_game.dart';
 import 'package:lichess_mobile/src/model/game/game_repository.dart';
@@ -12,11 +13,12 @@ part 'game_repository_providers.g.dart';
 /// Fetches a game from the local storage if available, otherwise fetches it from the server.
 @riverpod
 Future<ArchivedGame> archivedGame(Ref ref, {required GameId id}) async {
+  final isLoggedIn = ref.watch(isLoggedInProvider);
   final gameStorage = await ref.watch(gameStorageProvider.future);
   final game = await gameStorage.fetch(gameId: id);
   if (game != null) return game;
   return ref.withClientCacheFor(
-    (client) => GameRepository(client).getGame(id),
+    (client) => GameRepository(client).getGame(id, withBookmarked: isLoggedIn),
     const Duration(seconds: 10),
   );
 }

lib/src/view/game/archived_game_screen.dart

@@ -4,6 +4,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
 import 'package:intl/intl.dart';
 import 'package:lichess_mobile/src/model/analysis/analysis_controller.dart';
+import 'package:lichess_mobile/src/model/auth/auth_session.dart';
 import 'package:lichess_mobile/src/model/common/id.dart';
 import 'package:lichess_mobile/src/model/game/archived_game.dart';
 import 'package:lichess_mobile/src/model/game/game.dart';
@@ -44,7 +45,12 @@ class ArchivedGameScreen extends ConsumerWidget {
   @override
   Widget build(BuildContext context, WidgetRef ref) {
     if (gameData != null) {
-      return _Body(gameData: gameData, orientation: orientation, initialCursor: initialCursor);
+      return _Body(
+        gameData: gameData,
+        orientation: orientation,
+        isLoggedIn: ref.watch(isLoggedInProvider),
+        initialCursor: initialCursor,
+      );
     } else {
       return _LoadGame(gameId: gameId!, orientation: orientation, initialCursor: initialCursor);
     }
@@ -61,25 +67,40 @@ class _LoadGame extends ConsumerWidget {
   @override
   Widget build(BuildContext context, WidgetRef ref) {
     final game = ref.watch(archivedGameProvider(id: gameId));
+    final isLoggedIn = ref.watch(isLoggedInProvider);
+
     return game.when(
       data: (game) {
-        return _Body(gameData: game.data, orientation: orientation, initialCursor: initialCursor);
+        return _Body(
+          gameData: game.data,
+          orientation: orientation,
+          isLoggedIn: isLoggedIn,
+          initialCursor: initialCursor,
+        );
       },
-      loading: () => _Body(gameData: null, orientation: orientation, initialCursor: initialCursor),
+      loading:
+          () => _Body(
+            gameData: null,
+            orientation: orientation,
+            isLoggedIn: isLoggedIn,
+            initialCursor: initialCursor,
+          ),
       error: (error, stackTrace) {
         debugPrint('SEVERE: [ArchivedGameScreen] could not load game; $error\n$stackTrace');
         switch (error) {
           case ServerException _ when error.statusCode == 404:
             return _Body(
               gameData: null,
               orientation: orientation,
+              isLoggedIn: isLoggedIn,
               initialCursor: initialCursor,
               error: 'Game not found.',
             );
           default:
             return _Body(
               gameData: null,
               orientation: orientation,
+              isLoggedIn: isLoggedIn,
               initialCursor: initialCursor,
               error: error,
             );
@@ -90,10 +111,17 @@ class _LoadGame extends ConsumerWidget {
 }
 
 class _Body extends StatelessWidget {
-  const _Body({required this.gameData, required this.orientation, this.initialCursor, this.error});
+  const _Body({
+    required this.gameData,
+    required this.orientation,
+    required this.isLoggedIn,
+    this.initialCursor,
+    this.error,
+  });
 
   final LightArchivedGame? gameData;
   final Object? error;
+  final bool isLoggedIn;
   final Side orientation;
   final int? initialCursor;
 
@@ -104,6 +132,8 @@ class _Body extends StatelessWidget {
         title: gameData != null ? _GameTitle(gameData: gameData!) : const SizedBox.shrink(),
         actions: [
           if (gameData == null && error == null) const PlatformAppBarLoadingIndicator(),
+          if (gameData != null && isLoggedIn)
+            BookmarkButton(id: gameData!.id, bookmarked: gameData!.bookmarked!),
           const ToggleSoundButton(),
         ],
       ),