compose [nfc]: Make state "has-a" instead of "is-a" ComposeBoxController

We've been using ComposeBoxController as an interface, implemented
by _StreamComposeBoxState and _FixedDestinationComposeBoxState.

This commit puts the relevant implementation in ComposeBoxController
itself -- really in subclasses StreamComposeBoxController and
FixedDestinationComposeBoxController -- and makes those _FooState
classes instantiate it and store the instance in a field.

Next, we'll move the field up from those _FooState classes onto
ComposeBox's state to make the controller straightforwardly
available there (i.e. available without going through GlobalKey
logic). That will be helpful for zulip#720 when the controller grows a
send-in-progress flag; ComposeBox will be a conveniently central
place to build a progress indicator for that state.

Author: chrisbobbe

lib/widgets/action_sheet.dart

@@ -14,6 +14,7 @@ import '../model/narrow.dart';
 import 'actions.dart';
 import 'clipboard.dart';
 import 'color.dart';
+import 'compose_box.dart';
 import 'dialog.dart';
 import 'icons.dart';
 import 'inset_shadow.dart';
@@ -331,13 +332,12 @@ class QuoteAndReplyButton extends MessageActionSheetMenuItemButton {
     // or when a DM recipient becomes deactivated.
     var composeBoxController = findMessageListPage().composeBoxController;
     if (composeBoxController == null) return;
-    final topicController = composeBoxController.topicController;
     if (
-      topicController != null
-      && topicController.textNormalized == kNoTopicTopic
+      composeBoxController is StreamComposeBoxController
+      && composeBoxController.topicController.textNormalized == kNoTopicTopic
       && message is StreamMessage
     ) {
-      topicController.value = TextEditingValue(text: message.topic);
+      composeBoxController.topicController.value = TextEditingValue(text: message.topic);
     }
 
     // This inserts a "[Quoting…]" placeholder into the content input,

lib/widgets/compose_box.dart

@@ -1099,12 +1099,37 @@ class _ComposeBoxLayout extends StatelessWidget {
   }
 }
 
-abstract class ComposeBoxController<T extends StatefulWidget> extends State<T> {
-  ComposeTopicController? get topicController;
-  ComposeContentController get contentController;
-  FocusNode get contentFocusNode;
+sealed class ComposeBoxController {
+  ComposeContentController get contentController => _contentController;
+  final _contentController = ComposeContentController();
+
+  FocusNode get contentFocusNode => _contentFocusNode;
+  final _contentFocusNode = FocusNode();
+
+  @mustCallSuper
+  void dispose() {
+    _contentController.dispose();
+    _contentFocusNode.dispose();
+  }
+}
+
+class StreamComposeBoxController extends ComposeBoxController {
+  ComposeTopicController get topicController => _topicController;
+  final _topicController = ComposeTopicController();
+
+  FocusNode get topicFocusNode => _topicFocusNode;
+  final _topicFocusNode = FocusNode();
+
+  @override
+  void dispose() {
+    _topicController.dispose();
+    _topicFocusNode.dispose();
+    super.dispose();
+  }
 }
 
+class FixedDestinationComposeBoxController extends ComposeBoxController {}
+
 /// A compose box for use in a channel narrow.
 ///
 /// This offers a text input for the topic to send to,
@@ -1119,49 +1144,42 @@ class _StreamComposeBox extends StatefulWidget {
   State<_StreamComposeBox> createState() => _StreamComposeBoxState();
 }
 
-class _StreamComposeBoxState extends State<_StreamComposeBox> implements ComposeBoxController<_StreamComposeBox> {
-  @override ComposeTopicController get topicController => _topicController;
-  final _topicController = ComposeTopicController();
-
-  @override ComposeContentController get contentController => _contentController;
-  final _contentController = ComposeContentController();
-
-  @override FocusNode get contentFocusNode => _contentFocusNode;
-  final _contentFocusNode = FocusNode();
-
-  FocusNode get topicFocusNode => _topicFocusNode;
-  final _topicFocusNode = FocusNode();
+class _StreamComposeBoxState extends State<_StreamComposeBox> {
+  StreamComposeBoxController get controller => _controller;
+  final _controller = StreamComposeBoxController();
 
   @override
   void dispose() {
-    _topicController.dispose();
-    _contentController.dispose();
-    _contentFocusNode.dispose();
+    _controller.dispose();
     super.dispose();
   }
 
   @override
   Widget build(BuildContext context) {
+    final StreamComposeBoxController(
+      :topicController, :contentController, :topicFocusNode, :contentFocusNode,
+    ) = controller;
+
     return _ComposeBoxLayout(
-      contentController: _contentController,
-      contentFocusNode: _contentFocusNode,
+      contentController: contentController,
+      contentFocusNode: contentFocusNode,
       topicInput: _TopicInput(
         streamId: widget.narrow.streamId,
-        controller: _topicController,
+        controller: topicController,
         focusNode: topicFocusNode,
-        contentFocusNode: _contentFocusNode,
+        contentFocusNode: contentFocusNode,
       ),
       contentInput: _StreamContentInput(
         narrow: widget.narrow,
-        topicController: _topicController,
-        controller: _contentController,
-        focusNode: _contentFocusNode,
+        topicController: topicController,
+        controller: contentController,
+        focusNode: contentFocusNode,
       ),
       sendButton: _SendButton(
-        topicController: _topicController,
-        contentController: _contentController,
+        topicController: topicController,
+        contentController: contentController,
         getDestination: () => StreamDestination(
-          widget.narrow.streamId, _topicController.textNormalized),
+          widget.narrow.streamId, topicController.textNormalized),
       ));
   }
 }
@@ -1196,46 +1214,43 @@ class _FixedDestinationComposeBox extends StatefulWidget {
   State<_FixedDestinationComposeBox> createState() => _FixedDestinationComposeBoxState();
 }
 
-class _FixedDestinationComposeBoxState extends State<_FixedDestinationComposeBox> implements ComposeBoxController<_FixedDestinationComposeBox>  {
-  @override ComposeTopicController? get topicController => null;
-
-  @override ComposeContentController get contentController => _contentController;
-  final _contentController = ComposeContentController();
-
-  @override FocusNode get contentFocusNode => _contentFocusNode;
-  final _contentFocusNode = FocusNode();
+class _FixedDestinationComposeBoxState extends State<_FixedDestinationComposeBox> {
+  FixedDestinationComposeBoxController get controller => _controller;
+  final _controller = FixedDestinationComposeBoxController();
 
   @override
   void dispose() {
-    _contentController.dispose();
-    _contentFocusNode.dispose();
+    _controller.dispose();
     super.dispose();
   }
 
   @override
   Widget build(BuildContext context) {
+    final FixedDestinationComposeBoxController(
+      :contentController, :contentFocusNode,
+    ) = controller;
+
     return _ComposeBoxLayout(
-      contentController: _contentController,
-      contentFocusNode: _contentFocusNode,
+      contentController: contentController,
+      contentFocusNode: contentFocusNode,
       topicInput: null,
       contentInput: _FixedDestinationContentInput(
         narrow: widget.narrow,
-        controller: _contentController,
-        focusNode: _contentFocusNode,
+        controller: contentController,
+        focusNode: contentFocusNode,
       ),
       sendButton: _SendButton(
         topicController: null,
-        contentController: _contentController,
+        contentController: contentController,
         getDestination: () => widget.narrow.destination,
       ));
   }
 }
 
-class ComposeBox extends StatelessWidget {
-  ComposeBox({super.key, this.controllerKey, required this.narrow})
+class ComposeBox extends StatefulWidget {
+  ComposeBox({super.key, required this.narrow})
     : assert(ComposeBox.hasComposeBox(narrow));
 
-  final GlobalKey<ComposeBoxController>? controllerKey;
   final Narrow narrow;
 
   static bool hasComposeBox(Narrow narrow) {
@@ -1252,10 +1267,30 @@ class ComposeBox extends StatelessWidget {
     }
   }
 
+  @override
+  State<ComposeBox> createState() => _ComposeBoxState();
+}
+
+/// The interface for the state of a [ComposeBox].
+abstract class ComposeBoxState extends State<ComposeBox> {
+  ComposeBoxController? get controller;
+}
+
+class _ComposeBoxState extends State<ComposeBox> implements ComposeBoxState {
+  @override ComposeBoxController? get controller {
+    final forStream = _streamComposeBoxControllerKey.currentState?.controller;
+    final forFixedDestination = _fixedDestinationComposeBoxControllerKey.currentState?.controller;
+    assert(forStream == null || forFixedDestination == null);
+    // Both can be null (error-banner case).
+    return forStream ?? forFixedDestination;
+  }
+  final _streamComposeBoxControllerKey = GlobalKey<_StreamComposeBoxState>();
+  final _fixedDestinationComposeBoxControllerKey = GlobalKey<_FixedDestinationComposeBoxState>();
+
   Widget? _errorBanner(BuildContext context) {
     final store = PerAccountStoreWidget.of(context);
     final selfUser = store.users[store.selfUserId]!;
-    switch (narrow) {
+    switch (widget.narrow) {
       case ChannelNarrow(:final streamId):
       case TopicNarrow(:final streamId):
         final channel = store.streams[streamId];
@@ -1286,14 +1321,16 @@ class ComposeBox extends StatelessWidget {
       return _ComposeBoxContainer(child: errorBanner);
     }
 
-    final narrow = this.narrow;
+    final narrow = widget.narrow;
     switch (narrow) {
       case ChannelNarrow():
-        return _StreamComposeBox(key: controllerKey, narrow: narrow);
+        return _StreamComposeBox(key: _streamComposeBoxControllerKey, narrow: narrow);
       case TopicNarrow():
-        return _FixedDestinationComposeBox(key: controllerKey, narrow: narrow);
+        return _FixedDestinationComposeBox(key: _fixedDestinationComposeBoxControllerKey,
+          narrow: narrow);
       case DmNarrow():
-        return _FixedDestinationComposeBox(key: controllerKey, narrow: narrow);
+        return _FixedDestinationComposeBox(key: _fixedDestinationComposeBoxControllerKey,
+          narrow: narrow);
       case CombinedFeedNarrow():
       case MentionsNarrow():
       case StarredMessagesNarrow():

lib/widgets/message_list.dart

@@ -213,9 +213,9 @@ class _MessageListPageState extends State<MessageListPage> implements MessageLis
   late Narrow narrow;
 
   @override
-  ComposeBoxController? get composeBoxController => _composeBoxKey.currentState;
+  ComposeBoxController? get composeBoxController => _composeBoxKey.currentState?.controller;
 
-  final GlobalKey<ComposeBoxController> _composeBoxKey = GlobalKey();
+  final GlobalKey<ComposeBoxState> _composeBoxKey = GlobalKey();
 
   @override
   void initState() {
@@ -302,7 +302,7 @@ class _MessageListPageState extends State<MessageListPage> implements MessageLis
               child: Expanded(
                 child: MessageList(narrow: narrow, onNarrowChanged: _narrowChanged))),
             if (ComposeBox.hasComposeBox(narrow))
-              ComposeBox(controllerKey: _composeBoxKey, narrow: narrow)
+              ComposeBox(key: _composeBoxKey, narrow: narrow)
           ]))));
   }
 }

test/widgets/action_sheet_test.dart

@@ -230,8 +230,8 @@ void main() {
 
   group('QuoteAndReplyButton', () {
     ComposeBoxController? findComposeBoxController(WidgetTester tester) {
-      return tester.widgetList<ComposeBox>(find.byType(ComposeBox))
-        .singleOrNull?.controllerKey?.currentState;
+      return tester.stateList<ComposeBoxState>(find.byType(ComposeBox))
+        .singleOrNull?.controller;
     }
 
     Widget? findQuoteAndReplyButton(WidgetTester tester) {
@@ -283,14 +283,14 @@ void main() {
       final message = eg.streamMessage();
       await setupToMessageActionSheet(tester, message: message, narrow: ChannelNarrow(message.streamId));
 
-      final composeBoxController = findComposeBoxController(tester)!;
+      final composeBoxController = findComposeBoxController(tester) as StreamComposeBoxController;
       final contentController = composeBoxController.contentController;
 
       // Ensure channel-topics are loaded before testing quote & reply behavior
       connection.prepare(body:
         jsonEncode(GetStreamTopicsResult(topics: [eg.getStreamTopicsEntry()]).toJson()));
       final topicController = composeBoxController.topicController;
-      topicController?.value = const TextEditingValue(text: kNoTopicTopic);
+      topicController.value = const TextEditingValue(text: kNoTopicTopic);
 
       final valueBefore = contentController.value;
       prepareRawContentResponseSuccess(message: message, rawContent: 'Hello world');