refacto: replace hardcoded widget keys with type-safe enums

Author: Clement Guyon

integration_test/extensions/default_flows.dart

@@ -2,6 +2,7 @@ import 'dart:developer';
 
 import 'package:fluffychat/pages/chat_list/chat_list_body_view.dart';
 import 'package:fluffychat/pages/homeserver_picker/homeserver_picker.dart';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 
@@ -34,16 +35,6 @@ extension DefaultFlowExtensions on WidgetTester {
     // try {
     await Future.delayed(const Duration(milliseconds: 50));
 
-    await tester.scrollUntilVisible(
-      find.text('Login'),
-      500,
-      scrollable: find.descendant(
-        of: find.byKey(const Key('ConnectPageListView')),
-        matching: find.byType(Scrollable).first,
-      ),
-    );
-    await tester.pumpAndSettle();
-
     await tester.tap(find.text('Login'));
     await tester.pumpAndSettle();
     /*} catch (e) {
@@ -114,7 +105,7 @@ extension DefaultFlowExtensions on WidgetTester {
         find.text('Account'),
         500,
         scrollable: find.descendant(
-          of: find.byKey(const Key('SettingsListViewContent')),
+          of: find.byKey(SettingsKeys.listViewContent.key),
           matching: find.byType(Scrollable),
         ),
       );

integration_test/robots/home_robot.dart

@@ -1,5 +1,6 @@
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:fluffychat/widgets/twake_components/twake_navigation_icon/twake_navigation_icon.dart';
-import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
 import 'package:patrol/patrol.dart';
 import '../base/core_robot.dart';
 import 'chat_list_robot.dart';
@@ -18,7 +19,7 @@ class HomeRobot extends CoreRobot {
   }
 
   Future<PatrolFinder> getSettingTab() async {
-    return $(const Key('settings_navigation_destination'));
+    return $(find.byKey(NavigationKeys.settingsDestination.key));
   }
 
   Future<ContactListRobot> gotoContactListScreen() async {

integration_test/robots/setting/settings_privacy_and_security_robot.dart

@@ -1,5 +1,6 @@
 import 'package:fluffychat/pages/settings_dashboard/settings_contacts_visibility/settings_contacts_visibility_view.dart';
-import 'package:flutter/cupertino.dart';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
+import 'package:flutter_test/flutter_test.dart';
 import 'package:patrol/patrol.dart';
 
 import '../home_robot.dart';
@@ -8,7 +9,7 @@ class SettingsPrivacyAndSecurityRobot extends HomeRobot {
   SettingsPrivacyAndSecurityRobot(super.$);
 
   PatrolFinder contactVisibilitySetting() {
-    return $(const Key('contacts_visibility_settings_item'));
+    return $(find.byKey(SettingsKeys.contactsVisibilityItem.key));
   }
 
   Future<void> openContactVisibilitySetting() async {

lib/pages/bootstrap/init_client_dialog.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:fluffychat/pages/bootstrap/tom_bootstrap_dialog_mobile_view.dart';
 import 'package:fluffychat/pages/bootstrap/tom_bootstrap_dialog_web_view.dart';
 import 'package:fluffychat/presentation/model/client_login_state_event.dart';
@@ -27,14 +28,6 @@ class _InitClientDialogState extends State<InitClientDialog>
 
   StreamSubscription? _clientLoginStateChangedSubscription;
 
-  static const breakpointMobileDialogKey = Key(
-    'BreakPointMobileInitClientDialog',
-  );
-
-  static const breakpointWebAndDesktopDialogKey = Key(
-    'BreakpointWebAndDesktopKeyInitClientDialog',
-  );
-
   @override
   void initState() {
     _initial();
@@ -152,15 +145,15 @@ class _InitClientDialogState extends State<InitClientDialog>
         const WidthPlatformBreakpoint(
           end: ResponsiveUtils.maxMobileWidth,
         ): SlotLayout.from(
-          key: breakpointMobileDialogKey,
+          key: DialogKeys.initClientBreakpointMobile.key,
           builder: (_) => TomBootstrapDialogMobileView(
             description: L10n.of(context)!.backingUpYourMessage,
           ),
         ),
         const WidthPlatformBreakpoint(
           begin: ResponsiveUtils.minTabletWidth,
         ): SlotLayout.from(
-          key: breakpointWebAndDesktopDialogKey,
+          key: DialogKeys.initClientBreakpointWebAndDesktop.key,
           builder: (_) => TomBootstrapDialogWebView(
             description: L10n.of(context)!.backingUpYourMessage,
           ),

lib/pages/bootstrap/tom_bootstrap_dialog.dart

@@ -1,4 +1,5 @@
 import 'package:fluffychat/di/global/dio_cache_interceptor_for_client.dart';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:fluffychat/di/global/get_it_initializer.dart';
 import 'package:fluffychat/domain/model/recovery_words/recovery_words.dart';
 import 'package:fluffychat/domain/usecase/recovery/delete_recovery_words_interactor.dart';
@@ -47,12 +48,6 @@ class TomBootstrapDialogState extends State<TomBootstrapDialog>
   final _deleteRecoveryWordsInteractor = getIt
       .get<DeleteRecoveryWordsInteractor>();
 
-  static const breakpointMobileDialogKey = Key('BreakPointMobileDialog');
-
-  static const breakpointWebAndDesktopDialogKey = Key(
-    'BreakpointWebAndDesktopKeyDialog',
-  );
-
   static const Duration getRecoveryWordsDelay = Duration(seconds: 5);
 
   Bootstrap? bootstrap;
@@ -257,14 +252,14 @@ class TomBootstrapDialogState extends State<TomBootstrapDialog>
         const WidthPlatformBreakpoint(
           end: ResponsiveUtils.maxMobileWidth,
         ): SlotLayout.from(
-          key: breakpointMobileDialogKey,
+          key: DialogKeys.bootstrapBreakpointMobile.key,
           builder: (_) =>
               TomBootstrapDialogMobileView(description: _description),
         ),
         const WidthPlatformBreakpoint(
           begin: ResponsiveUtils.minTabletWidth,
         ): SlotLayout.from(
-          key: breakpointWebAndDesktopDialogKey,
+          key: DialogKeys.bootstrapBreakpointWebAndDesktop.key,
           builder: (_) => TomBootstrapDialogWebView(description: _description),
         ),
       },

lib/pages/chat/chat.dart

@@ -31,6 +31,7 @@ import 'package:fluffychat/pages/chat/dialog_reject_invite_widget.dart';
 import 'package:fluffychat/pages/chat/events/message_content_mixin.dart';
 import 'package:fluffychat/pages/chat/input_bar/focus_suggestion_controller.dart';
 import 'package:fluffychat/presentation/enum/chat/right_column_type_enum.dart';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:fluffychat/presentation/enum/chat/send_media_with_caption_status_enum.dart';
 import 'package:fluffychat/presentation/extensions/client_extension.dart';
 import 'package:fluffychat/presentation/extensions/event_update_extension.dart';
@@ -184,13 +185,11 @@ class ChatController extends State<Chat>
   final storeRecentReactionsInteractor = getIt
       .get<StoreRecentReactionsInteractor>();
 
-  final ValueKey chatComposerTypeAheadKey = const ValueKey(
-    'chatComposerTypeAheadKey',
-  );
+  final ValueKey<String> chatComposerTypeAheadKey =
+      ChatKeys.composerTypeAhead.valueKey;
 
-  final ValueKey _chatMediaPickerTypeAheadKey = const ValueKey(
-    'chatMediaPickerTypeAheadKey',
-  );
+  final ValueKey<String> _chatMediaPickerTypeAheadKey =
+      ChatKeys.mediaPickerTypeAhead.valueKey;
 
   StreamSubscription? onUpdateEventStreamSubcription;
 

lib/pages/chat/chat_scroll_view.dart

@@ -1,4 +1,5 @@
 import 'package:fluffychat/config/themes.dart';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:fluffychat/pages/chat/chat.dart';
 import 'package:fluffychat/pages/chat/chat_event_list_item.dart';
 import 'package:fluffychat/utils/matrix_sdk_extensions/event_list_extension.dart';
@@ -102,7 +103,7 @@ class _ChatScrollViewState extends State<ChatScrollView> {
 
   @override
   Widget build(BuildContext context) {
-    const centerKey = ValueKey('ChatEventList-center-key');
+    final centerKey = ChatKeys.eventListCenter.valueKey;
     final horizontalPadding = TwakeThemes.isColumnMode(context) ? 16.0 : 0.0;
 
     return Padding(

lib/pages/chat/send_file_dialog/send_file_dialog.dart

@@ -7,6 +7,7 @@ import 'package:fluffychat/domain/usecase/generate_thumbnails_media_interactor.d
 import 'package:fluffychat/pages/chat/input_bar/focus_suggestion_controller.dart';
 import 'package:fluffychat/pages/chat/send_file_dialog/send_file_dialog_view.dart';
 import 'package:fluffychat/presentation/list_notifier.dart';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:fluffychat/utils/manager/upload_manager/upload_manager.dart';
 import 'package:fluffychat/utils/matrix_sdk_extensions/matrix_file_extension.dart';
 import 'package:fluffychat/presentation/enum/chat/send_media_with_caption_status_enum.dart';
@@ -53,9 +54,8 @@ class SendFileDialogController extends State<SendFileDialog> {
 
   final FocusNode captionsFocusNode = FocusNode();
 
-  final ValueKey sendFileDialogTypeAheadKey = const ValueKey(
-    'sendFileDialogTypeAhead',
-  );
+  final ValueKey<String> sendFileDialogTypeAheadKey =
+      ChatKeys.sendFileDialogTypeAhead.valueKey;
 
   bool isSendMediaWithCaption = true;
 

lib/pages/chat_adaptive_scaffold/chat_adaptive_scaffold_builder.dart

@@ -1,7 +1,7 @@
 import 'package:fluffychat/presentation/enum/chat/right_column_type_enum.dart';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:fluffychat/utils/platform_infos.dart';
 import 'package:fluffychat/utils/responsive/responsive_utils.dart';
-import 'package:fluffychat/widgets/layouts/adaptive_layout/app_adaptive_scaffold.dart';
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_adaptive_scaffold/flutter_adaptive_scaffold.dart';
@@ -78,7 +78,7 @@ class ChatAdaptiveScaffoldBuilderController
             body: SlotLayout(
               config: {
                 WidthPlatformBreakpoint(end: breakpoint): SlotLayout.from(
-                  key: AppAdaptiveScaffold.breakpointMobileKey,
+                  key: NavigationKeys.breakpointMobile.key,
                   builder: (_) => Stack(
                     children: [
                       body!,
@@ -92,7 +92,7 @@ class ChatAdaptiveScaffoldBuilderController
                   ),
                 ),
                 WidthPlatformBreakpoint(begin: breakpoint): SlotLayout.from(
-                  key: AppAdaptiveScaffold.breakpointWebAndDesktopKey,
+                  key: NavigationKeys.breakpointWebAndDesktop.key,
                   builder: (_) => Container(
                     decoration: BoxDecoration(
                       border: Border(
@@ -113,13 +113,13 @@ class ChatAdaptiveScaffoldBuilderController
                 ? SlotLayout(
                     config: {
                       WidthPlatformBreakpoint(end: breakpoint): SlotLayout.from(
-                        key: AppAdaptiveScaffold.breakpointMobileKey,
+                        key: NavigationKeys.breakpointMobile.key,
                         builder: null,
                       ),
                       WidthPlatformBreakpoint(
                         begin: breakpoint,
                       ): SlotLayout.from(
-                        key: AppAdaptiveScaffold.breakpointWebAndDesktopKey,
+                        key: NavigationKeys.breakpointWebAndDesktop.key,
                         builder: (_) => widget.rightBuilder(
                           this,
                           isInStack: false,

lib/pages/chat_details/chat_details.dart

@@ -1,4 +1,5 @@
 import 'package:fluffychat/domain/model/room/room_extension.dart';
+import 'package:fluffychat/presentation/widget_keys/widget_keys.dart';
 import 'package:fluffychat/generated/l10n/app_localizations.dart';
 import 'package:fluffychat/pages/chat_details/chat_details_edit.dart';
 import 'package:fluffychat/pages/chat_details/chat_details_view.dart';
@@ -46,9 +47,9 @@ class ChatDetailsController extends State<ChatDetails>
         TickerProviderStateMixin,
         ChatDetailsTabMixin<ChatDetails>,
         TwakeContextMenuMixin {
-  final actionsMobileAndTabletKey = const Key('ActionsMobileAndTabletKey');
+  final actionsMobileAndTabletKey = ChatKeys.actionsMobileAndTablet.key;
 
-  final actionsWebAndDesktopKey = const Key('ActionsWebAndDesktopKey');
+  final actionsWebAndDesktopKey = ChatKeys.actionsWebAndDesktop.key;
 
   final muteNotifier = ValueNotifier<PushRuleState>(PushRuleState.notify);