Merge pull request #248 from lichess-org/wakelock

Add wakelock
lichess-org · Jul 31, 2023 · a776c69 · a776c69
2 parents 9687303 + 852f965
commit a776c69
Show file tree

Hide file tree

Showing 8 changed files with 76 additions and 3 deletions.
diff --git a/ios/Podfile.lock b/ios/Podfile.lock
@@ -101,6 +101,8 @@ PODS:
     - Flutter
   - url_launcher_ios (0.0.1):
     - Flutter
+  - wakelock_plus (0.0.1):
+    - Flutter
 
 DEPENDENCIES:
   - connectivity_plus (from `.symlinks/plugins/connectivity_plus/ios`)
@@ -119,6 +121,7 @@ DEPENDENCIES:
   - sqflite (from `.symlinks/plugins/sqflite/ios`)
   - stockfish (from `.symlinks/plugins/stockfish/ios`)
   - url_launcher_ios (from `.symlinks/plugins/url_launcher_ios/ios`)
+  - wakelock_plus (from `.symlinks/plugins/wakelock_plus/ios`)
 
 SPEC REPOS:
   trunk:
@@ -171,6 +174,8 @@ EXTERNAL SOURCES:
     :path: ".symlinks/plugins/stockfish/ios"
   url_launcher_ios:
     :path: ".symlinks/plugins/url_launcher_ios/ios"
+  wakelock_plus:
+    :path: ".symlinks/plugins/wakelock_plus/ios"
 
 SPEC CHECKSUMS:
   AppAuth: 3bb1d1cd9340bd09f5ed189fb00b1cc28e1e8570
@@ -204,6 +209,7 @@ SPEC CHECKSUMS:
   sqflite: 31f7eba61e3074736dff8807a9b41581e4f7f15a
   stockfish: 614d240ac2cd05a462dad552c7b5937bb14604fd
   url_launcher_ios: 08a3dfac5fb39e8759aeb0abbd5d9480f30fc8b4
+  wakelock_plus: 8b09852c8876491e4b6d179e17dfe2a0b5f60d47
 
 PODFILE CHECKSUM: 76a583f8d75b3a8c6e4bdc97ae8783ef36cc7984
 

diff --git a/lib/src/app.dart b/lib/src/app.dart
@@ -13,6 +13,7 @@ import 'package:lichess_mobile/src/model/settings/general_preferences.dart';
 import 'package:lichess_mobile/src/model/settings/board_preferences.dart';
 import 'package:lichess_mobile/src/widgets/bottom_navigation.dart';
 import 'package:lichess_mobile/src/utils/immersive_mode.dart';
+import 'package:lichess_mobile/src/utils/wakelock.dart';
 
 class LoadApp extends ConsumerWidget {
   const LoadApp({super.key});
@@ -106,6 +107,7 @@ class _AppState extends ConsumerState<App> {
       home: const BottomNavScaffold(),
       navigatorObservers: [
         immersiveModeRouteObserver,
+        wakelockRouteObserver,
       ],
     );
   }

diff --git a/lib/src/utils/wakelock.dart b/lib/src/utils/wakelock.dart
@@ -0,0 +1,43 @@
+import 'package:flutter/widgets.dart';
+import 'package:wakelock_plus/wakelock_plus.dart';
+
+final RouteObserver<PageRoute<void>> wakelockRouteObserver =
+    RouteObserver<PageRoute<void>>();
+
+/// State mixin that enables wakelock when the route is active.
+mixin Wakelock<T extends StatefulWidget> on State<T> implements RouteAware {
+  @override
+  void didChangeDependencies() {
+    super.didChangeDependencies();
+    final route = ModalRoute.of(context);
+    if (route != null && route is PageRoute) {
+      wakelockRouteObserver.subscribe(this, route);
+    }
+  }
+
+  @override
+  void dispose() {
+    wakelockRouteObserver.unsubscribe(this);
+    super.dispose();
+  }
+
+  @override
+  void didPopNext() {
+    WakelockPlus.enable();
+  }
+
+  @override
+  void didPush() {
+    WakelockPlus.enable();
+  }
+
+  @override
+  void didPop() {
+    WakelockPlus.disable();
+  }
+
+  @override
+  void didPushNext() {
+    WakelockPlus.disable();
+  }
+}
diff --git a/lib/src/view/game/game_screen.dart b/lib/src/view/game/game_screen.dart
@@ -25,6 +25,7 @@ import 'package:lichess_mobile/src/widgets/player.dart';
 import 'package:lichess_mobile/src/widgets/adaptive_dialog.dart';
 import 'package:lichess_mobile/src/widgets/settings.dart';
 import 'package:lichess_mobile/src/utils/immersive_mode.dart';
+import 'package:lichess_mobile/src/utils/wakelock.dart';
 import 'package:lichess_mobile/src/utils/l10n_context.dart';
 import 'package:lichess_mobile/src/utils/chessground_compat.dart';
 
@@ -46,7 +47,7 @@ class GameScreen extends ConsumerStatefulWidget {
 }
 
 class _GameScreenState extends ConsumerState<GameScreen>
-    with AndroidImmersiveMode, RouteAware {
+    with AndroidImmersiveMode, RouteAware, Wakelock {
   @override
   void didChangeDependencies() {
     super.didChangeDependencies();

diff --git a/lib/src/view/puzzle/puzzle_screen.dart b/lib/src/view/puzzle/puzzle_screen.dart
@@ -25,6 +25,7 @@ import 'package:lichess_mobile/src/model/engine/engine_evaluation.dart';
 import 'package:lichess_mobile/src/utils/immersive_mode.dart';
 import 'package:lichess_mobile/src/utils/l10n_context.dart';
 import 'package:lichess_mobile/src/utils/chessground_compat.dart';
+import 'package:lichess_mobile/src/utils/wakelock.dart';
 import 'package:lichess_mobile/src/view/engine/engine_gauge.dart';
 import 'package:lichess_mobile/src/view/settings/toggle_sound_button.dart';
 
@@ -140,7 +141,8 @@ class _Body extends ConsumerStatefulWidget {
   ConsumerState<_Body> createState() => _BodyState();
 }
 
-class _BodyState extends ConsumerState<_Body> with AndroidImmersiveMode {
+class _BodyState extends ConsumerState<_Body>
+    with AndroidImmersiveMode, Wakelock {
   @override
   Widget build(BuildContext context) {
     final ctrlProvider = puzzleCtrlProvider(widget.initialPuzzleContext);

diff --git a/lib/src/view/puzzle/storm_screen.dart b/lib/src/view/puzzle/storm_screen.dart
@@ -30,6 +30,7 @@ import 'package:lichess_mobile/src/widgets/list.dart';
 import 'package:lichess_mobile/src/utils/chessground_compat.dart';
 import "package:lichess_mobile/src/utils/l10n_context.dart";
 import "package:lichess_mobile/src/utils/immersive_mode.dart";
+import 'package:lichess_mobile/src/utils/wakelock.dart';
 import 'package:lichess_mobile/src/view/settings/toggle_sound_button.dart';
 
 import 'history_boards.dart';
@@ -109,7 +110,8 @@ class _Body extends ConsumerStatefulWidget {
   ConsumerState<_Body> createState() => _BodyState();
 }
 
-class _BodyState extends ConsumerState<_Body> with AndroidImmersiveMode {
+class _BodyState extends ConsumerState<_Body>
+    with AndroidImmersiveMode, Wakelock {
   @override
   Widget build(BuildContext context) {
     final ctrlProvider = stormCtrlProvider(widget.data.puzzles);

diff --git a/pubspec.lock b/pubspec.lock
@@ -1499,6 +1499,22 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "11.8.0"
+  wakelock_plus:
+    dependency: "direct main"
+    description:
+      name: wakelock_plus
+      sha256: aac3f3258f01781ec9212df94eecef1eb9ba9350e106728def405baa096ba413
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.1.1"
+  wakelock_plus_platform_interface:
+    dependency: transitive
+    description:
+      name: wakelock_plus_platform_interface
+      sha256: "40fabed5da06caff0796dc638e1f07ee395fb18801fbff3255a2372db2d80385"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.1.0"
   watcher:
     dependency: transitive
     description:

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -57,6 +57,7 @@ dependencies:
   crypto: ^3.0.3
   signal_strength_indicator: ^0.4.1
   flutter_spinkit: ^5.2.0
+  wakelock_plus: ^1.1.1
 
 dev_dependencies:
   build_runner: ^2.3.2