WIP basic search!

chrisbobbe · chrisbobbe · commit 0ef4fd6fca97 · 2025-07-03T12:49:47.000-07:00
Still TODO before shipping:

- "There are no messages here" placeholder text -- probably isn't
  ever right for the search page. Maybe we want one message for when
  there isn't (yet) a search query, and another message for when
  we've searched and there are no results.

- Tests, ideally

- Cut out `match_content` `match_topic` in message objects, for now
diff --git a/assets/l10n/app_en.arb b/assets/l10n/app_en.arb
@@ -534,6 +534,10 @@
   "@emptyMessageList": {
     "description": "Placeholder for some message-list pages when there are no messages."
   },
+  "emptyMessageListSearch": "No search results.",
+  "@emptyMessageListSearch": {
+    "description": "Placeholder for the 'Search' page when there are no messages."
+  },
   "messageListGroupYouWithYourself": "Messages with yourself",
   "@messageListGroupYouWithYourself": {
     "description": "Message list recipient header for a DM group that only includes yourself."
@@ -793,6 +797,18 @@
   "@userRoleUnknown": {
     "description": "Label for UserRole.unknown"
   },
+  "searchMessagesPageTitle": "Search",
+  "@searchMessagesPageTitle": {
+    "description": "Page title for the 'Search' message view."
+  },
+  "searchMessagesHintText": "Search",
+  "@searchMessagesHintText": {
+    "description": "Hint text for the message search text field."
+  },
+  "searchMessagesClearButtonTooltip": "Clear",
+  "@searchMessagesClearButtonTooltip": {
+    "description": "Tooltip for the 'x' button in the search text field."
+  },
   "inboxPageTitle": "Inbox",
   "@inboxPageTitle": {
     "description": "Title for the page with unreads."
diff --git a/lib/api/model/narrow.dart b/lib/api/model/narrow.dart
@@ -173,6 +173,20 @@ class ApiNarrowPmWith extends ApiNarrowDm {
   ApiNarrowPmWith._(super.operand, {super.negated});
 }
 
+/// An [ApiNarrowElement] with the 'search' operator.
+class ApiNarrowSearch extends ApiNarrowElement {
+  @override String get operator => 'search';
+
+  @override final String operand;
+
+  ApiNarrowSearch(this.operand, {super.negated});
+
+  factory ApiNarrowSearch.fromJson(Map<String, dynamic> json) => ApiNarrowSearch(
+    json['operand'] as String,
+    negated: json['negated'] as bool? ?? false,
+  );
+}
+
 class ApiNarrowIs extends ApiNarrowElement {
   @override String get operator => 'is';
 
diff --git a/lib/generated/l10n/zulip_localizations.dart b/lib/generated/l10n/zulip_localizations.dart
@@ -851,6 +851,12 @@ abstract class ZulipLocalizations {
   /// **'There are no messages here.'**
   String get emptyMessageList;
 
+  /// Placeholder for the 'Search' page when there are no messages.
+  ///
+  /// In en, this message translates to:
+  /// **'No search results.'**
+  String get emptyMessageListSearch;
+
   /// Message list recipient header for a DM group that only includes yourself.
   ///
   /// In en, this message translates to:
diff --git a/lib/generated/l10n/zulip_localizations_ar.dart b/lib/generated/l10n/zulip_localizations_ar.dart
@@ -437,6 +437,9 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Messages with yourself';
 
diff --git a/lib/generated/l10n/zulip_localizations_de.dart b/lib/generated/l10n/zulip_localizations_de.dart
@@ -452,6 +452,9 @@ class ZulipLocalizationsDe extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Nachrichten mit dir selbst';
 
diff --git a/lib/generated/l10n/zulip_localizations_en.dart b/lib/generated/l10n/zulip_localizations_en.dart
@@ -437,6 +437,9 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Messages with yourself';
 
diff --git a/lib/generated/l10n/zulip_localizations_it.dart b/lib/generated/l10n/zulip_localizations_it.dart
@@ -448,6 +448,9 @@ class ZulipLocalizationsIt extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Messaggi con te stesso';
 
diff --git a/lib/generated/l10n/zulip_localizations_ja.dart b/lib/generated/l10n/zulip_localizations_ja.dart
@@ -437,6 +437,9 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Messages with yourself';
 
diff --git a/lib/generated/l10n/zulip_localizations_nb.dart b/lib/generated/l10n/zulip_localizations_nb.dart
@@ -437,6 +437,9 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Messages with yourself';
 
diff --git a/lib/generated/l10n/zulip_localizations_pl.dart b/lib/generated/l10n/zulip_localizations_pl.dart
@@ -446,6 +446,9 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Zapiski na własne konto';
 
diff --git a/lib/generated/l10n/zulip_localizations_ru.dart b/lib/generated/l10n/zulip_localizations_ru.dart
@@ -446,6 +446,9 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Сообщения с собой';
 
diff --git a/lib/generated/l10n/zulip_localizations_sk.dart b/lib/generated/l10n/zulip_localizations_sk.dart
@@ -437,6 +437,9 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Messages with yourself';
 
diff --git a/lib/generated/l10n/zulip_localizations_sl.dart b/lib/generated/l10n/zulip_localizations_sl.dart
@@ -458,6 +458,9 @@ class ZulipLocalizationsSl extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Sporočila sebi';
 
diff --git a/lib/generated/l10n/zulip_localizations_uk.dart b/lib/generated/l10n/zulip_localizations_uk.dart
@@ -448,6 +448,9 @@ class ZulipLocalizationsUk extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Повідомлення з собою';
 
diff --git a/lib/generated/l10n/zulip_localizations_zh.dart b/lib/generated/l10n/zulip_localizations_zh.dart
@@ -437,6 +437,9 @@ class ZulipLocalizationsZh extends ZulipLocalizations {
   @override
   String get emptyMessageList => 'There are no messages here.';
 
+  @override
+  String get emptyMessageListSearch => 'No search results.';
+
   @override
   String get messageListGroupYouWithYourself => 'Messages with yourself';
 
diff --git a/lib/model/autocomplete.dart b/lib/model/autocomplete.dart
@@ -486,6 +486,7 @@ class MentionAutocompleteView extends AutocompleteView<MentionAutocompleteQuery,
       case CombinedFeedNarrow():
       case MentionsNarrow():
       case StarredMessagesNarrow():
+      case KeywordSearchNarrow():
         assert(false, 'No compose box, thus no autocomplete is available in ${narrow.runtimeType}.');
     }
     return (userA, userB) => _compareByRelevance(userA, userB,
diff --git a/lib/model/internal_link.dart b/lib/model/internal_link.dart
@@ -92,6 +92,8 @@ Uri narrowLink(PerAccountStore store, Narrow narrow, {int? nearMessageId}) {
         fragment.write(element.operand.toString());
       case ApiNarrowMessageId():
         fragment.write(element.operand.toString());
+      case ApiNarrowSearch():
+        fragment.write(_encodeHashComponent(element.operand));
     }
   }
 
diff --git a/lib/model/message_list.dart b/lib/model/message_list.dart
@@ -654,7 +654,8 @@ class MessageListView with ChangeNotifier, _MessageSequence {
       || TopicNarrow()
       || DmNarrow() => false,
     MentionsNarrow()
-      || StarredMessagesNarrow() => true,
+      || StarredMessagesNarrow()
+      || KeywordSearchNarrow() => true,
   };
 
   /// Whether [message] should actually appear in this message list,
@@ -683,6 +684,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
       case DmNarrow():
       case MentionsNarrow():
       case StarredMessagesNarrow():
+      case KeywordSearchNarrow():
         return true;
     }
   }
@@ -702,6 +704,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
       case DmNarrow():
       case MentionsNarrow():
       case StarredMessagesNarrow():
+      case KeywordSearchNarrow():
         return VisibilityEffect.none;
     }
   }
@@ -719,6 +722,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
       case DmNarrow():
       case MentionsNarrow():
       case StarredMessagesNarrow():
+      case KeywordSearchNarrow():
         return true;
     }
   }
@@ -734,6 +738,17 @@ class MessageListView with ChangeNotifier, _MessageSequence {
   Future<void> fetchInitial() async {
     assert(!fetched && !haveOldest && !haveNewest && !busyFetchingMore);
     assert(messages.isEmpty && contents.isEmpty);
+
+    if (narrow case KeywordSearchNarrow(keyword: '')) {
+      // The server would reject an empty keyword search; skip the request.
+      // TODO this seems like an awkward layer to handle this at --
+      //   probably better if the UI code doesn't take it to this point.
+      _haveOldest = true;
+      _haveNewest = true;
+      _setStatus(FetchingStatus.idle, was: FetchingStatus.unstarted);
+      return;
+    }
+
     _setStatus(FetchingStatus.fetchInitial, was: FetchingStatus.unstarted);
     // TODO schedule all this in another isolate
     final generation = this.generation;
@@ -1137,6 +1152,14 @@ class MessageListView with ChangeNotifier, _MessageSequence {
         // Recipient headers, and downstream of those, may change, though.
         _messagesMovedInternally(messageIds);
 
+      case KeywordSearchNarrow():
+        // This might not be quite true, since matches can be determined by
+        // the topic alone, and topics change. Punt on trying to add/remove
+        // messages, though, because we aren't equipped to evaluate the match
+        // without asking the server.
+        _messagesMovedInternally(messageIds);
+
+
       case ChannelNarrow(:final streamId):
         switch ((origStreamId == streamId, newStreamId == streamId)) {
           case (false, false): return;
diff --git a/lib/model/narrow.dart b/lib/model/narrow.dart
@@ -368,3 +368,31 @@ class StarredMessagesNarrow extends Narrow {
   @override
   int get hashCode => 'StarredMessagesNarrow'.hashCode;
 }
+
+/// A keyword-search narrow.
+///
+/// [keyword] must have been trimmed with [String.trim].
+class KeywordSearchNarrow extends Narrow {
+  KeywordSearchNarrow(this.keyword)
+    : assert(keyword.trim() == keyword);
+
+  final String keyword;
+
+  @override
+  bool? containsMessage(MessageBase message) => null;
+
+  @override
+  ApiNarrow apiEncode() => [ApiNarrowSearch(keyword)];
+
+  @override
+  String toString() => 'KeywordSearchNarrow($keyword)';
+
+  @override
+  bool operator ==(Object other) {
+    if (other is! KeywordSearchNarrow) return false;
+    return other.keyword == keyword;
+  }
+
+  @override
+  int get hashCode => Object.hash('KeywordSearchNarrow', keyword);
+}
diff --git a/lib/model/settings.dart b/lib/model/settings.dart
@@ -317,6 +317,7 @@ class GlobalSettingsStore extends ChangeNotifier {
           => true,
         CombinedFeedNarrow() || ChannelNarrow()
         || MentionsNarrow() || StarredMessagesNarrow()
+        || KeywordSearchNarrow()
           => false,
       },
     };
@@ -344,6 +345,7 @@ class GlobalSettingsStore extends ChangeNotifier {
           => true,
         CombinedFeedNarrow() || ChannelNarrow()
         || MentionsNarrow() || StarredMessagesNarrow()
+        || KeywordSearchNarrow()
           => false,
       },
     };
diff --git a/lib/model/unreads.dart b/lib/model/unreads.dart
@@ -197,6 +197,9 @@ class Unreads extends PerAccountStoreBase with ChangeNotifier {
   // TODO: Implement unreads handling.
   int countInStarredMessagesNarrow() => 0;
 
+  // TODO: Implement unreads handling?
+  int countInKeywordSearchNarrow() => 0;
+
   int countInNarrow(Narrow narrow) {
     switch (narrow) {
       case CombinedFeedNarrow():
@@ -211,6 +214,8 @@ class Unreads extends PerAccountStoreBase with ChangeNotifier {
         return countInMentionsNarrow();
       case StarredMessagesNarrow():
         return countInStarredMessagesNarrow();
+      case KeywordSearchNarrow():
+        return countInKeywordSearchNarrow();
     }
   }
 
diff --git a/lib/widgets/compose_box.dart b/lib/widgets/compose_box.dart
@@ -1831,6 +1831,7 @@ class ComposeBox extends StatefulWidget {
       case CombinedFeedNarrow():
       case MentionsNarrow():
       case StarredMessagesNarrow():
+      case KeywordSearchNarrow():
         return false;
     }
   }
@@ -2049,6 +2050,7 @@ class _ComposeBoxState extends State<ComposeBox> with PerAccountStoreAwareStateM
       case CombinedFeedNarrow():
       case MentionsNarrow():
       case StarredMessagesNarrow():
+      case KeywordSearchNarrow():
         assert(false);
     }
   }
@@ -2083,6 +2085,7 @@ class _ComposeBoxState extends State<ComposeBox> with PerAccountStoreAwareStateM
       case CombinedFeedNarrow():
       case MentionsNarrow():
       case StarredMessagesNarrow():
+      case KeywordSearchNarrow():
         return null;
     }
     return null;
diff --git a/lib/widgets/home.dart b/lib/widgets/home.dart
@@ -267,7 +267,7 @@ void _showMainMenu(BuildContext context, {
   required ValueNotifier<_HomePageTab> tabNotifier,
 }) {
   final menuItems = <Widget>[
-    // TODO(#252): Search
+    const _SearchButton(),
     // const SizedBox(height: 8),
     _InboxButton(tabNotifier: tabNotifier),
     // TODO: Recent conversations
@@ -427,6 +427,24 @@ abstract class _NavigationBarMenuButton extends _MenuButton {
   }
 }
 
+class _SearchButton extends _MenuButton {
+  const _SearchButton();
+
+  @override
+  IconData get icon => ZulipIcons.search;
+
+  @override
+  String label(ZulipLocalizations zulipLocalizations) {
+    return zulipLocalizations.searchMessagesPageTitle;
+  }
+
+  @override
+  void onPressed(BuildContext context) {
+    Navigator.of(context).push(MessageListPage.buildRoute(
+      context: context, narrow: KeywordSearchNarrow('')));
+  }
+}
+
 class _InboxButton extends _NavigationBarMenuButton {
   const _InboxButton({required super.tabNotifier});
 
diff --git a/lib/widgets/message_list.dart b/lib/widgets/message_list.dart
diff --git a/lib/widgets/theme.dart b/lib/widgets/theme.dart
diff --git a/test/model/message_list_test.dart b/test/model/message_list_test.dart
diff --git a/test/widgets/message_list_test.dart b/test/widgets/message_list_test.dart
