refactor: move youAre, me and opponent fields to BaseGame

Author: tom-anders

lib/src/model/correspondence/correspondence_game_storage.dart

@@ -115,7 +115,7 @@ class CorrespondenceGameStorage {
   Future<void> save(OfflineCorrespondenceGame game) async {
     try {
       await _db.insert(kCorrespondenceStorageTable, {
-        'userId': game.me.user?.id.toString() ?? kCorrespondenceStorageAnonId,
+        'userId': game.me?.user?.id.toString() ?? kCorrespondenceStorageAnonId,
         'gameId': game.id.toString(),
         'lastModified': DateTime.now().toIso8601String(),
         'data': jsonEncode(game.toJson()),

lib/src/model/correspondence/correspondence_service.dart

@@ -218,7 +218,7 @@ class CorrespondenceService {
         perf: game.meta.perf,
         white: game.white,
         black: game.black,
-        youAre: game.youAre!,
+        youAre: game.youAre,
         daysPerTurn: game.meta.daysPerTurn,
         clock: game.correspondenceClock,
         winner: game.winner,

lib/src/model/correspondence/offline_correspondence_game.dart

@@ -14,6 +14,9 @@ part 'offline_correspondence_game.freezed.dart';
 part 'offline_correspondence_game.g.dart';
 
 /// An offline correspondence game.
+///
+/// This is always a game of the current user, so [youAre], [me] and [opponent]
+/// are always guaranteed to be non-null.
 @Freezed(fromJson: true, toJson: true)
 class OfflineCorrespondenceGame
     with _$OfflineCorrespondenceGame, BaseGame, IndexableSteps
@@ -35,7 +38,7 @@ class OfflineCorrespondenceGame
     required Perf perf,
     required Player white,
     required Player black,
-    required Side youAre,
+    required Side? youAre,
     int? daysPerTurn,
     Side? winner,
     bool? isThreefoldRepetition,
@@ -45,22 +48,19 @@ class OfflineCorrespondenceGame
   factory OfflineCorrespondenceGame.fromJson(Map<String, dynamic> json) =>
       _$OfflineCorrespondenceGameFromJson(json);
 
-  Side get orientation => youAre;
+  Side get orientation => youAre!;
 
   @override
   IList<Duration>? get clocks => null;
 
   @override
   IList<ExternalEval>? get evals => null;
 
-  Player get me => youAre == Side.white ? white : black;
-  Player get opponent => youAre == Side.white ? black : white;
-
   Side get sideToMove => lastPosition.turn;
 
   bool get isMyTurn => sideToMove == youAre;
 
-  Duration? myTimeLeft(DateTime lastModifiedTime) => estimatedTimeLeft(youAre, lastModifiedTime);
+  Duration? myTimeLeft(DateTime lastModifiedTime) => estimatedTimeLeft(youAre!, lastModifiedTime);
 
   Duration? estimatedTimeLeft(Side side, DateTime lastModifiedTime) {
     final timeLeft = side == Side.white ? clock?.white : clock?.black;

lib/src/model/game/archived_game.dart

@@ -64,22 +64,6 @@ class ArchivedGame with _$ArchivedGame, BaseGame, IndexableSteps implements Base
 
   /// Create an archived game from a local storage JSON.
   factory ArchivedGame.fromJson(Map<String, dynamic> json) => _$ArchivedGameFromJson(json);
-
-  /// Player point of view. Null if spectating.
-  Player? get me =>
-      youAre == null
-          ? null
-          : youAre == Side.white
-          ? white
-          : black;
-
-  /// Opponent point of view. Null if spectating.
-  Player? get opponent =>
-      youAre == null
-          ? null
-          : youAre == Side.white
-          ? black
-          : white;
 }
 
 /// A [LightArchivedGame] associated with a point of view of a player.

lib/src/model/game/game.dart

@@ -39,13 +39,33 @@ abstract mixin class BaseGame {
 
   GameStatus get status;
 
+  /// This field is null if the game is being watched as a spectator, and
+  /// represents the side that the current player is playing as otherwise.
+  Side? get youAre;
+
   Side? get winner;
 
   bool? get isThreefoldRepetition;
 
   Player get white;
   Player get black;
 
+  /// Player of the playing point of view. Null if spectating.
+  Player? get me =>
+      youAre == null
+          ? null
+          : youAre == Side.white
+          ? white
+          : black;
+
+  /// Opponent from the playing point of view. Null if spectating.
+  Player? get opponent =>
+      youAre == null
+          ? null
+          : youAre == Side.white
+          ? black
+          : white;
+
   Position get lastPosition;
 
   Side? playerSideOf(UserId id) {

lib/src/model/game/playable_game.dart

@@ -73,22 +73,6 @@ class PlayableGame with _$PlayableGame, BaseGame, IndexableSteps implements Base
     return _playableGameFromPick(pick(json).required());
   }
 
-  /// Player of the playing point of view. Null if spectating.
-  Player? get me =>
-      youAre == null
-          ? null
-          : youAre == Side.white
-          ? white
-          : black;
-
-  /// Opponent from the playing point of view. Null if spectating.
-  Player? get opponent =>
-      youAre == null
-          ? null
-          : youAre == Side.white
-          ? black
-          : white;
-
   Side get sideToMove => lastPosition.turn;
 
   bool get hasAI => white.isAI || black.isAI;

lib/src/view/correspondence/offline_correspondence_game_screen.dart

@@ -181,7 +181,7 @@ class _BodyState extends ConsumerState<_Body> {
           child: SafeArea(
             bottom: false,
             child: BoardTable(
-              orientation: isBoardTurned ? youAre.opposite : youAre,
+              orientation: isBoardTurned ? youAre!.opposite : youAre!,
               fen: position.fen,
               lastMove: game.moveAt(stepCursor) as NormalMove?,
               gameData: GameData(
@@ -229,7 +229,7 @@ class _BodyState extends ConsumerState<_Body> {
                   builder:
                       (_) => AnalysisScreen(
                         options: AnalysisOptions(
-                          orientation: game.youAre,
+                          orientation: game.youAre!,
                           standalone: (
                             pgn: game.makePgn(),
                             isComputerAnalysisAllowed: false,

lib/src/view/game/game_player.dart

@@ -7,10 +7,8 @@ import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
 import 'package:lichess_mobile/src/constants.dart';
-import 'package:lichess_mobile/src/model/auth/auth_session.dart';
 import 'package:lichess_mobile/src/model/common/service/sound_service.dart';
 import 'package:lichess_mobile/src/model/game/game.dart';
-import 'package:lichess_mobile/src/model/game/game_status.dart';
 import 'package:lichess_mobile/src/model/game/material_diff.dart';
 import 'package:lichess_mobile/src/model/settings/board_preferences.dart';
 import 'package:lichess_mobile/src/styles/lichess_colors.dart';
@@ -26,7 +24,7 @@ import 'package:lichess_mobile/src/view/user/user_screen.dart';
 import 'package:lichess_mobile/src/widgets/buttons.dart';
 
 /// A widget to display player information above/below the chess board.
-class GamePlayer extends ConsumerWidget {
+class GamePlayer extends StatelessWidget {
   const GamePlayer({
     required this.game,
     required this.side,
@@ -61,14 +59,12 @@ class GamePlayer extends ConsumerWidget {
   final Duration? timeToMove;
 
   @override
-  Widget build(BuildContext context, WidgetRef ref) {
+  Widget build(BuildContext context) {
     final remaingHeight = estimateRemainingHeightLeftBoard(context);
     final playerFontSize = remaingHeight <= kSmallRemainingHeightLeftBoardThreshold ? 14.0 : 16.0;
 
     final player = side == Side.white ? game.white : game.black;
 
-    final session = ref.watch(authSessionProvider);
-
     final playerWidget = Column(
       mainAxisAlignment: MainAxisAlignment.center,
       crossAxisAlignment: CrossAxisAlignment.start,
@@ -129,9 +125,7 @@ class GamePlayer extends ConsumerWidget {
               if (player.rating != null)
                 RatingPrefAware(
                   isActiveGameOfCurrentUser:
-                      game.status.value < GameStatus.aborted.value &&
-                      session != null &&
-                      game.playerSideOf(session.user.id) != null,
+                      game.status.value < GameStatus.aborted.value && game.me != null,
                   child: Text.rich(
                     TextSpan(
                       text: ' ${player.rating}${player.provisional == true ? '?' : ''}',

lib/src/view/game/offline_correspondence_games_screen.dart

@@ -67,7 +67,7 @@ class OfflineCorrespondenceGamePreview extends ConsumerWidget {
         crossAxisAlignment: CrossAxisAlignment.start,
         mainAxisAlignment: MainAxisAlignment.spaceAround,
         children: [
-          UserFullNameWidget(user: game.opponent.user, style: Styles.boardPreviewTitle),
+          UserFullNameWidget(user: game.opponent!.user, style: Styles.boardPreviewTitle),
           if (game.myTimeLeft(lastModified) != null)
             Text(relativeDate(context.l10n, DateTime.now().add(game.myTimeLeft(lastModified)!))),
           Icon(game.perf.icon, size: 40, color: DefaultTextStyle.of(context).style.color),

lib/src/view/home/home_tab_screen.dart

@@ -537,10 +537,10 @@ class _OfflineCorrespondenceCarousel extends ConsumerWidget {
                   perf: el.$2.perf,
                   speed: el.$2.speed,
                   variant: el.$2.variant,
-                  opponent: el.$2.opponent.user,
+                  opponent: el.$2.opponent!.user,
                   isMyTurn: el.$2.isMyTurn,
-                  opponentRating: el.$2.opponent.rating,
-                  opponentAiLevel: el.$2.opponent.aiLevel,
+                  opponentRating: el.$2.opponent!.rating,
+                  opponentAiLevel: el.$2.opponent!.aiLevel,
                   lastMove: el.$2.lastMove,
                   secondsLeft: el.$2.myTimeLeft(el.$1)?.inSeconds,
                 ),