1043 add castling method option v2 #1347

Jimima · 2025-01-08T13:05:30Z

Adds an option to change castling method. Still needs some work to tidy up but the approach is implemented. Note that it only really works for Standard variants as chess960 always uses king over rook. I think this is okay but maybe the UI could make this clearer.

veloce · 2025-01-09T12:24:23Z

Just for my understanding, why the v1 was closed? thanks :)

Jimima · 2025-01-09T13:22:34Z

Sure, I had attempted an implementation that modified dartchess and chessground which maybe was not the correct approach. I didn't have a great deal of time to look at it at that point so I just closed the PRs for hygeine. See here for reference lichess-org/dartchess#44

This change is limited to only the mobile app with no changes elsewhere. Not sure if this is the right approach still, happy to be told if you think there is an alternative way to come at it

Jimima · 2025-01-17T11:12:51Z

I think this is ready to be looked at @veloce. Not sure what's going on with the tests but maybe an issue unrelated to this PR?

julien4215 · 2025-01-19T10:54:03Z

A fix was pushed on the main branch. The tests need to be rerun manually.

veloce · 2025-01-20T02:39:58Z

@Jimima can you rebase your branch on top of main so the tests pass? thank.

Jimima · 2025-01-20T08:50:01Z

@veloce done!

veloce

Thanks for this. This is looking good but there are a couple of issues to address on top of the comments I've made:

for now this settings applies only to online games, but it should also apply to puzzles, analysis, study, etc.
the logic you added to game_controller.dart must be refactored so it can work everywhere.
this is the time for a refactoring: we need a global board wrapper so we can apply settings to the whole app
a good starting point for this refactoring imo, is the private _BoardWidget which should be extracted to a public widget in another file. It should be modified to take only BoardPrefs and BoardSettingsOverride (and not directly the ChessboardSettings from chessground which should be constructed inside the widget from the prefs and the optional override).
the new castling logic should be tested

veloce · 2025-01-21T03:47:48Z

lib/src/model/settings/board_preferences.dart

+
+  // TODO: l10n
+  String get label => switch (this) {
+    CastlingMethod.kingOverRook => 'Move king over rook',


translation keys already exist: look at app_en.arb: preferencesCastleByMovingOntoTheRook.

veloce · 2025-01-21T03:49:12Z

lib/src/model/settings/board_preferences.dart

+enum CastlingMethod {
+  kingOverRook,
+  kingTwoSquares,
+  either;


We should not support either because it is not supported on website.

The default is kingOverRook

Default is now either since we'll support all three castling methods which is correctly set on line 159.

veloce · 2025-01-21T03:50:32Z

lib/src/view/settings/board_settings_screen.dart

@@ -369,3 +429,11 @@ String pieceShiftMethodl10n(BuildContext context, PieceShiftMethod pieceShiftMet
      PieceShiftMethod.drag => context.l10n.preferencesDragPiece,
      PieceShiftMethod.tapTwoSquares => 'Tap two squares',
    };
+
+String castlingMethodl10n(BuildContext context, CastlingMethod castlingMethod) =>


Duplicated l10n logic; must be defined directly in the enum to be consistent with rest of code.

Jimima · 2025-01-21T09:11:03Z

Thanks for the feedback, that all makes sense. I also wonder if we are worried about premoves respecting the preference as right now they do not. I think the main site does not either but I would need to check this.

Jimima · 2025-01-29T10:27:28Z

@veloce I would appreciate another review if possible, I have made a few changes:

Created a new BoardWidget component and use this in place of Chessboard where possible
Used translation strings for labels etc.

Some questions:

I wonder if we can support either castling method in the app as it seems like an improvement over the web site. I have left it in for now but can easily remove it if you prefer.

Right now I kept the refactoring light and boardPrefs is passed in as a parameter. Should the board widget be fetching the boardPrefs directly from the shared state rather than taking it as a parameter?

Is there further refactoring to be done? You mentioned taking only BoardPrefs and BoardSettingsOverride but I was a bit unsure about how to make this work. Any further guidance would be gratefully received 🙂

Jimima · 2025-01-29T10:28:26Z

Oh yes, also I will add some tests in the meantime

…ethod-option-v2' into 1043-add-castling-method-option-v2

veloce · 2025-01-30T09:31:52Z

Will review asap.

I wonder if we can support either castling method in the app as it seems like an improvement over the web site. I have left it in for now but can easily remove it if you prefer.

No here I think we should stick to what the website does. It would be less error prone and easier to maintain.

CloudyDino · 2025-02-07T20:10:33Z

@veloce The website only gives two castling options, but the second castling option (move king onto rook) still allows you to move the king two spaces to castle. So in reality the two options on the website are

Move king two squares
Either (move king two squares or move king onto rook)

If we're going to stick to what the website does, we should make sure to do it this way or include all three options since the website options aren't explicit enough.

Lichess.Website.-.Move.king.onto.rook.mov

veloce · 2025-02-10T15:08:06Z

I wish the website would have more explicit options indeed.

veloce · 2025-02-10T15:09:29Z

Sorry @Jimima for the delay I was focused on fixing the new theme. Could you fix the conflicts and I look at this asap. Thanks!

veloce · 2025-02-10T15:10:39Z

Oh, by the way if we have to support the "either" as the website I'd rather have an "either" choice in the settings as you did initially and asked you to remove... sorry about that.

CloudyDino · 2025-02-10T16:35:08Z

lib/src/view/settings/board_settings_screen.dart

+                  Navigator.of(context).push(CastlingMethodSettingsScreen.buildRoute(context));
+                  // pushPlatformRoute(
+                  //   context,
+                  //   title: context.l10n.preferencesCastleByMovingTheKingTwoSquaresOrOntoTheRook,
+                  //   builder: (context) => const CastlingMethodSettingsScreen(),
+                  // );


Quick question, should this be commented out or deleted?

Will remove

CloudyDino · 2025-02-10T16:36:33Z

lib/src/model/settings/board_preferences.dart

+enum CastlingMethod {
+  kingOverRook,
+  kingTwoSquares,
+  either;


Default is now either since we'll support all three castling methods which is correctly set on line 159.

CloudyDino · 2025-02-10T16:39:52Z

lib/src/model/settings/board_preferences.dart

+      switch (castlingMethod) {
+        CastlingMethod.kingOverRook => context.l10n.preferencesCastleByMovingOntoTheRook,
+        CastlingMethod.kingTwoSquares => context.l10n.preferencesCastleByMovingTwoSquares,
+        CastlingMethod.either => context.l10n.preferencesBothClicksAndDrag,


Should we be using preferencesBothClicksAndDrag here? If the string gets changed in the future from "Either" to "Either click or drag", then we wouldn't want the castling method string to change to that as well. I'm unsure when new strings should be created or if maybe we should rename preferencesBothClicksAndDrag to something like preferencesEither

Yeah good point, not sure how to correctly handle this as there is no string currently for this. Maybe I just hard code an english string and add a comment?

Yeah just hardcode it for now and leave a // TODO translate

CloudyDino · 2025-02-10T16:41:22Z

lib/src/view/analysis/analysis_board.dart

@@ -88,6 +90,7 @@ class AnalysisBoardState extends ConsumerState<AnalysisBoard> {
                .onUserMove(move, shouldReplace: widget.shouldReplaceChildOnUserMove),
        onPromotionSelection: (role) => ref.read(ctrlProvider.notifier).onPromotionSelection(role),
      ),
+


nit: extra line I think?

CloudyDino · 2025-02-10T16:42:07Z

lib/src/view/broadcast/broadcast_game_screen.dart

@@ -354,6 +355,7 @@ class _BroadcastBoardState extends ConsumerState<_BroadcastBoard> {
          newShapeColor: boardPrefs.shapeColor.color,
        ),
      ),
+      boardPrefs: boardPrefs,


nit: maybe we add this new line right under the size argument to keep argument order the same

CloudyDino · 2025-02-10T16:43:31Z

lib/src/view/study/study_screen.dart

@@ -568,6 +569,7 @@ class _StudyBoardState extends ConsumerState<_StudyBoard> {
                },
              )
              : null,
+      boardPrefs: boardPrefs,


nit: same here, maybe we add this new line right under the size argument to keep argument order the same

…a/lichess-mobile into 1043-add-castling-method-option-v2

Jimima · 2025-02-10T17:23:48Z

@veloce thanks, and no problem at all. I am still not sure of the correct approach here, as I said, happy to take a steer from you if you think there is more to do with refactoring or whatever. I might need some guidance, however :-)

veloce

Good job, I think it's taking the right direction. Made a couple of small comments.

Now, this touches crucial part of the app (board for games and analysis) so this change should be tested.

It should be a widget test for the new BoardWidget that test at least the correct behaviour of castling according to all possible settings.

You can look at existing puzzle_screen_test.dart, game_screen_test.dart or flutter-chessground tests for inspiration.

veloce · 2025-02-12T10:35:13Z

lib/src/model/settings/board_preferences.dart

+      switch (castlingMethod) {
+        CastlingMethod.kingOverRook => context.l10n.preferencesCastleByMovingOntoTheRook,
+        CastlingMethod.kingTwoSquares => context.l10n.preferencesCastleByMovingTwoSquares,
+        CastlingMethod.either => context.l10n.preferencesBothClicksAndDrag,


Yeah just hardcode it for now and leave a // TODO translate

veloce · 2025-02-12T10:36:36Z

lib/src/view/settings/board_settings_screen.dart

+  static Route<dynamic> buildRoute(BuildContext context) {
+    return buildScreenRoute(
+      context,
+      screen: const BoardClockPositionScreen(),


Wrong screen here.

veloce · 2025-02-12T10:36:49Z

lib/src/view/settings/board_settings_screen.dart

+    return buildScreenRoute(
+      context,
+      screen: const BoardClockPositionScreen(),
+      title: 'Clock position',


Wrong title.

veloce · 2025-02-12T10:37:19Z

lib/src/view/settings/board_settings_screen.dart

+
+    return CupertinoPageScaffold(
+      navigationBar: const CupertinoNavigationBar(),
+      child: SafeArea(


No need to have a SafeArea around ListView.

veloce · 2025-02-12T10:37:53Z

lib/src/widgets/board.dart

+
+  @override
+  Widget build(BuildContext context) {
+    final Map<Square, Square> castlingMap = {


This could be a static const.

veloce · 2025-02-12T10:39:54Z

lib/src/widgets/board.dart

+import 'package:flutter/material.dart';
+import 'package:lichess_mobile/src/model/settings/board_preferences.dart';
+
+class BoardWidget extends StatelessWidget {


A doc comment indicating the purpose of this widget would be welcome.

veloce · 2025-02-12T10:41:18Z

lib/src/widgets/board.dart

+  final BoardPrefs boardPrefs;
+  final String fen;
+  final Side orientation;
+  final GameData? gameData;


Here I don't think GameData should be nullable. This board widget purpose is to wrap interactive boards only.

Perhaps renaming it to InteractiveBoardWidget would make it even clearer.

This is a holdover from boardTable where this was refactored out from. boardTable can take a null value which is then passed in here. I can change this but I'm not totally clear on how to handle the case where boardTable does not have gameData. Happy to take a steer here as I can see a few solutions but not sure which is best.

veloce · 2025-02-12T10:43:37Z

lib/src/widgets/board.dart

+          child: Container(
+            decoration: BoxDecoration(
+              color:
+                  Theme.of(context).platform == TargetPlatform.iOS


Since the new theme we can remove these distinctions between iOS and android. So use colorScheme.surface on both platforms.

I should have changed it in the new theme PR, but let's do it here.

Jimima · 2025-02-12T22:22:14Z

Thanks for the comments I'll get to work on this

Jimima force-pushed the 1043-add-castling-method-option-v2 branch from c97a375 to b2a2c28 Compare January 17, 2025 10:52

Jimima added 6 commits January 17, 2025 10:52

Initial implementation

92ec7b8

Initial implementation

a3a4dd0

Fix merge errors

af02c69

Formatting

ab1df72

Added labels

cd26a45

Format fix

c8348c0

Jimima force-pushed the 1043-add-castling-method-option-v2 branch from b2a2c28 to c8348c0 Compare January 17, 2025 10:54

Jimima marked this pull request as ready for review January 17, 2025 11:12

Merge branch 'lichess-org:main' into 1043-add-castling-method-option-v2

5e4a995

veloce reviewed Jan 21, 2025

View reviewed changes

Jimima marked this pull request as draft January 21, 2025 09:13

Jimima added 5 commits January 22, 2025 09:50

Initial board widget refactor

bd116aa

Moved logic into board widget

b303806

Removed commented code

647e37e

Fixed issues and tidied up

1d901c6

Merge branch 'lichess-org:main' into 1043-add-castling-method-option-v2

981d0d3

Jimima marked this pull request as ready for review January 29, 2025 10:27

Jimima added 3 commits January 29, 2025 11:37

Removed TODO

5064c88

Merge branch 'lichess-org:main' into 1043-add-castling-method-option-v2

cce8762

Merge remote-tracking branch 'refs/remotes/origin/1043-add-castling-m…

23cf849

…ethod-option-v2' into 1043-add-castling-method-option-v2

Merge branch 'main' into 1043-add-castling-method-option-v2

82ffcc0

Jimima added 4 commits February 10, 2025 15:36

Merge branch 'main' into 1043-add-castling-method-option-v2

1eb5432

Fixes

e876e05

Fix format

b48e8a2

Merge branch 'main' into 1043-add-castling-method-option-v2

da320a7

CloudyDino reviewed Feb 10, 2025

View reviewed changes

Jimima added 4 commits February 10, 2025 17:02

Removed commented code

8797ee1

Merge branch '1043-add-castling-method-option-v2' of github.com:Jimim…

0a0d44b

…a/lichess-mobile into 1043-add-castling-method-option-v2

Reordered params

a7fb84b

Format fix

41b71d2

veloce reviewed Feb 12, 2025

View reviewed changes

Jimima added 4 commits February 13, 2025 14:57

Various fixes

8007d11

Removed import

b6960c1

Organised imports

e3f9d15

Merge branch 'main' into 1043-add-castling-method-option-v2

5775ce0

1043 add castling method option v2 #1347

Are you sure you want to change the base?

1043 add castling method option v2 #1347

Conversation

Jimima commented Jan 8, 2025

veloce commented Jan 9, 2025

Jimima commented Jan 9, 2025

Jimima commented Jan 17, 2025

julien4215 commented Jan 19, 2025

veloce commented Jan 20, 2025

Jimima commented Jan 20, 2025

veloce left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimima commented Jan 21, 2025

Jimima commented Jan 29, 2025

Jimima commented Jan 29, 2025

veloce commented Jan 30, 2025

CloudyDino commented Feb 7, 2025

veloce commented Feb 10, 2025

veloce commented Feb 10, 2025

veloce commented Feb 10, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimima Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimima commented Feb 10, 2025

veloce left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimima commented Feb 12, 2025

Jimima Feb 10, 2025 •

edited

Loading

veloce left a comment •

edited

Loading