Simplify evaluation service (#2554)

Author: veloce

lib/src/binding.dart

@@ -4,7 +4,7 @@ import 'package:firebase_messaging/firebase_messaging.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/widgets.dart';
 import 'package:lichess_mobile/firebase_options.dart';
-import 'package:lichess_mobile/src/model/engine/engine.dart';
+import 'package:multistockfish/multistockfish.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
 /// A singleton class that provides access to plugins and external APIs.
@@ -82,8 +82,8 @@ abstract class LichessBinding {
   /// Wraps [FirebaseMessaging.onBackgroundMessage].
   void firebaseMessagingOnBackgroundMessage(BackgroundMessageHandler handler);
 
-  /// The factory to create Stockfish
-  StockfishFactory get stockfishFactory;
+  /// The Stockfish singleton instance.
+  Stockfish get stockfish;
 }
 
 /// A concrete implementation of [LichessBinding] for the app.
@@ -169,5 +169,5 @@ class AppLichessBinding extends LichessBinding {
       FirebaseMessaging.onMessageOpenedApp;
 
   @override
-  StockfishFactory get stockfishFactory => const StockfishFactory();
+  Stockfish get stockfish => Stockfish.instance;
 }

lib/src/log.dart

@@ -1,4 +1,5 @@
 import 'dart:developer' as developer;
+import 'dart:io' show Platform;
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
@@ -28,11 +29,15 @@ class AppLogService {
   Iterable<LogRecord> get logs => _logs.values;
 
   void start() {
-    ref.listen(logPreferencesProvider.select((prefs) => prefs.level), (prev, next) {
-      if (next != prev) {
-        Logger.root.level = next;
-      }
-    }, fireImmediately: true);
+    if (kDebugMode) {
+      Logger.root.level = Level.ALL;
+    } else {
+      ref.listen(logPreferencesProvider.select((prefs) => prefs.level), (prev, next) {
+        if (next != prev) {
+          Logger.root.level = next;
+        }
+      }, fireImmediately: true);
+    }
 
     Logger.root.onRecord.listen((record) {
       if (kDebugMode) {
@@ -45,7 +50,9 @@ class AppLogService {
           stackTrace: record.stackTrace,
         );
 
-        if (_loggersToShowInTerminal.contains(record.loggerName) && record.level >= Level.FINE) {
+        if (_loggersToShowInTerminal.contains(record.loggerName) &&
+            record.level >= Level.FINE &&
+            !Platform.environment.containsKey('FLUTTER_TEST')) {
           debugPrint('[${record.loggerName}] ${record.message}');
         }
       } else {

lib/src/model/analysis/analysis_controller.dart

@@ -341,7 +341,11 @@ class AnalysisController extends AsyncNotifier<AnalysisState>
       contextOpening: opening,
       isComputerAnalysisAllowed: isComputerAnalysisAllowed,
       isServerAnalysisEnabled: prefs.enableServerAnalysis,
-      evaluationContext: EvaluationContext(variant: _variant, initialPosition: _root.position),
+      evaluationContext: EvaluationContext(
+        id: options.gameId,
+        variant: _variant,
+        initialPosition: _root.position,
+      ),
       playersAnalysis: serverAnalysis,
       acplChartData: serverAnalysis != null ? _makeAcplChartData() : null,
       division: division,

lib/src/model/analysis/retro_controller.dart

@@ -144,6 +144,7 @@ class RetroController extends AsyncNotifier<RetroState> with EngineEvaluationMix
         variant: _game.meta.variant,
         currentPath: UciPath.empty,
         evaluationContext: EvaluationContext(
+          id: options.id,
           variant: _game.meta.variant,
           initialPosition: _root.position,
         ),
@@ -234,6 +235,7 @@ class RetroController extends AsyncNotifier<RetroState> with EngineEvaluationMix
       lastMove: mistakes.firstOrNull?.branch.sanMove.move,
       variant: _game.meta.variant,
       evaluationContext: EvaluationContext(
+        id: options.id,
         variant: _game.meta.variant,
         initialPosition: _root.position,
       ),

lib/src/model/broadcast/broadcast_analysis_controller.dart

@@ -134,6 +134,7 @@ class BroadcastAnalysisController extends AsyncNotifier<BroadcastAnalysisState>
       lastMove: lastMove,
       pov: Side.white,
       evaluationContext: EvaluationContext(
+        id: params.gameId,
         variant: Variant.standard,
         initialPosition: _root.position,
       ),

lib/src/model/engine/engine.dart

@@ -1,254 +1,16 @@
-import 'dart:async';
-
-import 'package:flutter/foundation.dart';
-import 'package:lichess_mobile/src/binding.dart';
 import 'package:lichess_mobile/src/constants.dart';
-import 'package:lichess_mobile/src/model/engine/uci_protocol.dart';
-import 'package:lichess_mobile/src/model/engine/work.dart';
-import 'package:logging/logging.dart';
 import 'package:multistockfish/multistockfish.dart';
 
-enum EngineState { initial, loading, idle, computing, error, disposed }
-
-/// An engine that can compute chess positions.
-///
-/// This is a high-level abstraction over a chess engine process.
-///
-/// See [StockfishEngine] for a concrete implementation.
-abstract class Engine {
-  /// The current state of the engine.
-  ValueListenable<EngineState> get state;
-
-  /// The name of the engine.
-  String get name;
-
-  /// Start the engine with the given [work].
-  Stream<EvalResult> start(Work work);
-
-  /// Stop the engine current computation.
-  void stop();
-
-  /// A future that completes once the underlying engine process is exited.
-  Future<void> get exited;
-
-  /// Whether the engine is disposed.
-  ///
-  /// This will be `true` once [dispose] is called. Once the engine is disposed, it cannot be
-  /// used anymore, and [start] and [stop] methods will throw a [StateError].
-  bool get isDisposed;
-
-  /// Dispose the engine. It cannot be used after this method is called.
-  ///
-  /// Returns the same future as [exited], that completes once the underlying engine process is exited.
-  ///
-  /// It is safe to call this method multiple times.
-  Future<void> dispose();
-}
-
 const _nnueDownloadUrl = '$kLichessCDNHost/assets/lifat/nnue/';
 
-/// A concrete implementation of [Engine] that uses Stockfish as the underlying engine.
-class StockfishEngine implements Engine {
-  StockfishEngine(this.flavor, {String? smallNetPath, String? bigNetPath})
-    : _protocol = UCIProtocol(),
-      _smallNetPath = smallNetPath,
-      _bigNetPath = bigNetPath,
-      assert(
-        flavor != StockfishFlavor.latestNoNNUE || smallNetPath != null && bigNetPath != null,
-        'NNUE paths must be provided for chess flavor',
-      );
-
-  /// URL to download the latest big NNUE network.
-  static final bigNetUrl = Uri.parse('$_nnueDownloadUrl${Stockfish.latestBigNNUE}');
-
-  /// SHA256 hash (first 12 digits) of the latest big NNUE network.
-  static final bigNetHash = Stockfish.latestBigNNUE.substring(3, 15);
-
-  /// URL to download the latest small NNUE network.
-  static final smallNetUrl = Uri.parse('$_nnueDownloadUrl${Stockfish.latestSmallNNUE}');
-
-  /// SHA256 hash (first 12 digits) of the latest small NNUE network.
-  static final smallNetHash = Stockfish.latestSmallNNUE.substring(3, 15);
-
-  final StockfishFlavor flavor;
-  final UCIProtocol _protocol;
-  final String? _smallNetPath;
-  final String? _bigNetPath;
-
-  Stockfish? _stockfish;
-  String _name = 'Stockfish';
-  StreamSubscription<String>? _stdoutSubscription;
-
-  bool _isDisposed = false;
-
-  final _state = ValueNotifier(EngineState.initial);
-
-  final _log = Logger('StockfishEngine');
-
-  /// A completer that completes once the underlying engine has exited.
-  final _exitCompleter = Completer<void>();
-
-  @override
-  ValueListenable<EngineState> get state => _state;
-
-  @override
-  String get name => _name;
-
-  @override
-  Future<void> get exited => _exitCompleter.future;
-
-  @override
-  bool get isDisposed => _isDisposed;
-
-  @override
-  Stream<EvalResult> start(Work work) {
-    if (isDisposed) {
-      throw StateError('Engine is disposed');
-    }
-
-    _log.info('engine start at ply ${work.position.ply} and path ${work.path}');
-    _protocol.compute(work);
-
-    if (_stockfish == null) {
-      try {
-        final stockfish = LichessBinding.instance.stockfishFactory(
-          flavor,
-          smallNetPath: _smallNetPath,
-          bigNetPath: _bigNetPath,
-        );
-        _stockfish = stockfish;
-
-        _state.value = EngineState.loading;
-        _stdoutSubscription = stockfish.stdout.listen((line) {
-          _protocol.received(line);
-        });
-
-        stockfish.state.addListener(_stockfishStateListener);
-
-        // Ensure the engine is ready before sending commands
-        void onReadyOnce() {
-          if (stockfish.state.value == StockfishState.ready) {
-            _protocol.connected((String cmd) {
-              stockfish.stdin = cmd;
-            });
-            stockfish.state.removeListener(onReadyOnce);
-          }
-        }
-
-        stockfish.state.addListener(onReadyOnce);
-
-        // Check immediately in case the engine is already ready
-        // This prevents a race where the engine becomes ready between
-        // adding _stockfishStateListener and adding onReadyOnce
-        if (stockfish.state.value == StockfishState.ready) {
-          onReadyOnce();
-        }
-
-        _protocol.isComputing.addListener(() {
-          if (_protocol.isComputing.value) {
-            _state.value = EngineState.computing;
-          } else {
-            _state.value = EngineState.idle;
-          }
-        });
-        _protocol.engineName.then((name) {
-          _name = name;
-        });
-      } catch (e, s) {
-        _stockfish = null;
-        _log.severe('error loading stockfish', e, s);
-        _state.value = EngineState.error;
-      }
-    }
-
-    return _protocol.evalStream.where((e) => e.$1 == work);
-  }
-
-  void _stockfishStateListener() {
-    switch (_stockfish?.state.value) {
-      case StockfishState.ready:
-        _state.value = EngineState.idle;
-      case StockfishState.error:
-        _state.value = EngineState.error;
-      case StockfishState.disposed:
-        _log.info('engine disposed');
-        _state.value = EngineState.disposed;
-        _exitCompleter.complete();
-        _stockfish?.state.removeListener(_stockfishStateListener);
-        _state.dispose();
-      default:
-      // do nothing
-    }
-  }
-
-  @override
-  void stop() {
-    if (isDisposed) {
-      throw StateError('Engine is disposed');
-    }
-    _protocol.compute(null);
-  }
-
-  @override
-  Future<void> dispose() {
-    if (isDisposed) {
-      return exited;
-    }
-    _log.fine('disposing engine');
-    _isDisposed = true;
-    _stdoutSubscription?.cancel();
-    _protocol.dispose();
-    if (_stockfish != null) {
-      switch (_stockfish!.state.value) {
-        case StockfishState.disposed:
-        case StockfishState.error:
-          if (_exitCompleter.isCompleted == false) {
-            _exitCompleter.complete();
-          }
-        case StockfishState.ready:
-          _stockfish!.dispose();
-        case StockfishState.initial:
-        case StockfishState.starting:
-          // wait to be ready or error, then dispose
-          void onReadyOrErrorOnce() {
-            final currentState = _stockfish!.state.value;
-            if (currentState == StockfishState.ready) {
-              _stockfish!.dispose();
-              _stockfish!.state.removeListener(onReadyOrErrorOnce);
-            } else if (currentState == StockfishState.error ||
-                currentState == StockfishState.disposed) {
-              if (_exitCompleter.isCompleted == false) {
-                _exitCompleter.complete();
-              }
-              _stockfish!.state.removeListener(onReadyOrErrorOnce);
-            }
-          }
-          _stockfish!.state.addListener(onReadyOrErrorOnce);
-          // Check immediately in case state already transitioned
-          onReadyOrErrorOnce();
-      }
-    } else {
-      if (_exitCompleter.isCompleted == false) {
-        _exitCompleter.complete();
-      }
-    }
-    return exited;
-  }
-}
-
-/// A factory to create a [Stockfish].
-///
-/// This is useful to be able to mock [Stockfish] in tests.
-class StockfishFactory {
-  const StockfishFactory();
+/// URL to download the latest big NNUE network.
+final bigNetUrl = Uri.parse('$_nnueDownloadUrl${Stockfish.latestBigNNUE}');
 
-  Stockfish call(
-    StockfishFlavor flavor, {
+/// SHA256 hash (first 12 digits) of the latest big NNUE network.
+final bigNetHash = Stockfish.latestBigNNUE.substring(3, 15);
 
-    /// Full path to the small net file for NNUE evaluation.
-    String? smallNetPath,
+/// URL to download the latest small NNUE network.
+final smallNetUrl = Uri.parse('$_nnueDownloadUrl${Stockfish.latestSmallNNUE}');
 
-    /// Full path to the big net file for NNUE evaluation.
-    String? bigNetPath,
-  }) => Stockfish(flavor: flavor, smallNetPath: smallNetPath, bigNetPath: bigNetPath);
-}
+/// SHA256 hash (first 12 digits) of the latest small NNUE network.
+final smallNetHash = Stockfish.latestSmallNNUE.substring(3, 15);