compose: Use alternative placeholder if topics are mandatory and missing

PIG208 · PIG208 · commit eb461ffe174b · 2025-02-10T19:57:20.000-05:00
Previously, the placeholder reads "#channel name &gt; (no topic)" even if
topics are mandatory for the realm.

Signed-off-by: Zixuan James Li &lt;zixuan@zulip.com&gt;
diff --git a/assets/l10n/app_en.arb b/assets/l10n/app_en.arb
@@ -348,9 +348,16 @@
   "@composeBoxSelfDmContentHint": {
     "description": "Hint text for content input when sending a message to yourself."
   },
-  "composeBoxChannelContentHint": "Message #{channel} > {topic}",
+  "composeBoxChannelContentHint": "Message #{channel}",
   "@composeBoxChannelContentHint": {
     "description": "Hint text for content input when sending a message to a channel",
+    "placeholders": {
+      "channel": {"type": "String", "example": "channel name"}
+    }
+  },
+  "composeBoxChannelTopicContentHint": "Message #{channel} > {topic}",
+  "@composeBoxChannelTopicContentHint": {
+    "description": "Hint text for content input when sending a message to a topic in a channel",
     "placeholders": {
       "channel": {"type": "String", "example": "channel name"},
       "topic": {"type": "String", "example": "topic name"}
diff --git a/assets/l10n/app_pl.arb b/assets/l10n/app_pl.arb
@@ -263,20 +263,6 @@
   "@composeBoxSelfDmContentHint": {
     "description": "Hint text for content input when sending a message to yourself."
   },
-  "composeBoxChannelContentHint": "Wiadomość #{channel} > {topic}",
-  "@composeBoxChannelContentHint": {
-    "description": "Hint text for content input when sending a message to a channel",
-    "placeholders": {
-      "channel": {
-        "type": "String",
-        "example": "channel name"
-      },
-      "topic": {
-        "type": "String",
-        "example": "topic name"
-      }
-    }
-  },
   "composeBoxTopicHintText": "Wątek",
   "@composeBoxTopicHintText": {
     "description": "Hint text for topic input widget in compose box."
diff --git a/assets/l10n/app_ru.arb b/assets/l10n/app_ru.arb
@@ -373,20 +373,6 @@
   "@composeBoxGenericContentHint": {
     "description": "Hint text for content input when sending a message."
   },
-  "composeBoxChannelContentHint": "Сообщение для #{channel} > {topic}",
-  "@composeBoxChannelContentHint": {
-    "description": "Hint text for content input when sending a message to a channel",
-    "placeholders": {
-      "channel": {
-        "type": "String",
-        "example": "channel name"
-      },
-      "topic": {
-        "type": "String",
-        "example": "topic name"
-      }
-    }
-  },
   "composeBoxSendTooltip": "Отправить",
   "@composeBoxSendTooltip": {
     "description": "Tooltip for send button in compose box."
diff --git a/lib/generated/l10n/zulip_localizations.dart b/lib/generated/l10n/zulip_localizations.dart
@@ -570,8 +570,14 @@ abstract class ZulipLocalizations {
   /// Hint text for content input when sending a message to a channel
   ///
   /// In en, this message translates to:
+  /// **'Message #{channel}'**
+  String composeBoxChannelContentHint(String channel);
+
+  /// Hint text for content input when sending a message to a topic in a channel
+  ///
+  /// In en, this message translates to:
   /// **'Message #{channel} > {topic}'**
-  String composeBoxChannelContentHint(String channel, String topic);
+  String composeBoxChannelTopicContentHint(String channel, String topic);
 
   /// Tooltip for send button in compose box.
   ///
diff --git a/lib/generated/l10n/zulip_localizations_ar.dart b/lib/generated/l10n/zulip_localizations_ar.dart
@@ -276,7 +276,12 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   String get composeBoxSelfDmContentHint => 'Jot down something';
 
   @override
-  String composeBoxChannelContentHint(String channel, String topic) {
+  String composeBoxChannelContentHint(String channel) {
+    return 'Message #$channel';
+  }
+
+  @override
+  String composeBoxChannelTopicContentHint(String channel, String topic) {
     return 'Message #$channel > $topic';
   }
 
diff --git a/lib/generated/l10n/zulip_localizations_en.dart b/lib/generated/l10n/zulip_localizations_en.dart
@@ -276,7 +276,12 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   String get composeBoxSelfDmContentHint => 'Jot down something';
 
   @override
-  String composeBoxChannelContentHint(String channel, String topic) {
+  String composeBoxChannelContentHint(String channel) {
+    return 'Message #$channel';
+  }
+
+  @override
+  String composeBoxChannelTopicContentHint(String channel, String topic) {
     return 'Message #$channel > $topic';
   }
 
diff --git a/lib/generated/l10n/zulip_localizations_ja.dart b/lib/generated/l10n/zulip_localizations_ja.dart
@@ -276,7 +276,12 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   String get composeBoxSelfDmContentHint => 'Jot down something';
 
   @override
-  String composeBoxChannelContentHint(String channel, String topic) {
+  String composeBoxChannelContentHint(String channel) {
+    return 'Message #$channel';
+  }
+
+  @override
+  String composeBoxChannelTopicContentHint(String channel, String topic) {
     return 'Message #$channel > $topic';
   }
 
diff --git a/lib/generated/l10n/zulip_localizations_nb.dart b/lib/generated/l10n/zulip_localizations_nb.dart
@@ -276,7 +276,12 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
   String get composeBoxSelfDmContentHint => 'Jot down something';
 
   @override
-  String composeBoxChannelContentHint(String channel, String topic) {
+  String composeBoxChannelContentHint(String channel) {
+    return 'Message #$channel';
+  }
+
+  @override
+  String composeBoxChannelTopicContentHint(String channel, String topic) {
     return 'Message #$channel > $topic';
   }
 
diff --git a/lib/generated/l10n/zulip_localizations_pl.dart b/lib/generated/l10n/zulip_localizations_pl.dart
@@ -276,8 +276,13 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
   String get composeBoxSelfDmContentHint => 'Zanotuj coś na przyszłość';
 
   @override
-  String composeBoxChannelContentHint(String channel, String topic) {
-    return 'Wiadomość #$channel > $topic';
+  String composeBoxChannelContentHint(String channel) {
+    return 'Message #$channel';
+  }
+
+  @override
+  String composeBoxChannelTopicContentHint(String channel, String topic) {
+    return 'Message #$channel > $topic';
   }
 
   @override
diff --git a/lib/generated/l10n/zulip_localizations_ru.dart b/lib/generated/l10n/zulip_localizations_ru.dart
@@ -276,8 +276,13 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
   String get composeBoxSelfDmContentHint => 'Сделать заметку';
 
   @override
-  String composeBoxChannelContentHint(String channel, String topic) {
-    return 'Сообщение для #$channel > $topic';
+  String composeBoxChannelContentHint(String channel) {
+    return 'Message #$channel';
+  }
+
+  @override
+  String composeBoxChannelTopicContentHint(String channel, String topic) {
+    return 'Message #$channel > $topic';
   }
 
   @override
diff --git a/lib/generated/l10n/zulip_localizations_sk.dart b/lib/generated/l10n/zulip_localizations_sk.dart
@@ -276,7 +276,12 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
   String get composeBoxSelfDmContentHint => 'Jot down something';
 
   @override
-  String composeBoxChannelContentHint(String channel, String topic) {
+  String composeBoxChannelContentHint(String channel) {
+    return 'Message #$channel';
+  }
+
+  @override
+  String composeBoxChannelTopicContentHint(String channel, String topic) {
     return 'Message #$channel > $topic';
   }
 
diff --git a/lib/widgets/compose_box.dart b/lib/widgets/compose_box.dart
@@ -587,8 +587,11 @@ class _StreamContentInputState extends State<_StreamContentInput> {
       narrow: widget.narrow,
       destination: TopicNarrow(widget.narrow.streamId, topic),
       controller: widget.controller,
-      hintText: zulipLocalizations.composeBoxChannelContentHint(
-        streamName, topic.displayName));
+      hintText: store.realmMandatoryTopics
+        && widget.controller.topic.isTopicEmpty
+          ? zulipLocalizations.composeBoxChannelContentHint(streamName)
+          : zulipLocalizations.composeBoxChannelTopicContentHint(
+              streamName, topic.displayName));
   }
 }
 
@@ -646,7 +649,7 @@ class _FixedDestinationContentInput extends StatelessWidget {
         final store = PerAccountStoreWidget.of(context);
         final streamName = store.streams[streamId]?.name
           ?? zulipLocalizations.unknownChannelName;
-        return zulipLocalizations.composeBoxChannelContentHint(
+        return zulipLocalizations.composeBoxChannelTopicContentHint(
           streamName, topic.displayName);
 
       case DmNarrow(otherRecipientIds: []): // The self-1:1 thread.
diff --git a/test/widgets/compose_box_test.dart b/test/widgets/compose_box_test.dart
@@ -326,11 +326,13 @@ void main() {
 
     Future<void> prepare(WidgetTester tester, {
       required Narrow narrow,
+      bool? mandatoryTopics,
     }) async {
       await prepareComposeBox(tester,
         narrow: narrow,
         otherUsers: [eg.otherUser, eg.thirdUser],
-        streams: [channel]);
+        streams: [channel],
+        mandatoryTopics: mandatoryTopics);
     }
 
     void checkComposeBoxHintTexts(WidgetTester tester, {
@@ -347,17 +349,19 @@ void main() {
         of: contentInputFinder, matching: find.text(contentHintText))).findsOne();
     }
 
-    group('to ChannelNarrow', () {
+    group('to ChannelNarrow, topics not mandatory', () {
       testWidgets('with empty topic', (tester) async {
-        await prepare(tester, narrow: ChannelNarrow(channel.streamId));
+        await prepare(tester, narrow: ChannelNarrow(channel.streamId),
+          mandatoryTopics: false);
         checkComposeBoxHintTexts(tester,
           topicHintText: 'Topic',
           contentHintText: 'Message #${channel.name} > (no topic)');
       });
 
       testWidgets('with non-empty topic', (tester) async {
         final narrow = ChannelNarrow(channel.streamId);
-        await prepare(tester, narrow: narrow);
+        await prepare(tester, narrow: narrow,
+          mandatoryTopics: false);
         await enterTopic(tester, narrow: narrow, topic: 'new topic');
         await tester.pump();
         checkComposeBoxHintTexts(tester,
@@ -366,6 +370,25 @@ void main() {
       });
     });
 
+    testWidgets('to ChannelNarrow, mandatory topics with empty topic', (tester) async {
+      await prepare(tester, narrow: ChannelNarrow(channel.streamId),
+        mandatoryTopics: true);
+      checkComposeBoxHintTexts(tester,
+        topicHintText: 'Topic',
+        contentHintText: 'Message #${channel.name}');
+    });
+
+    testWidgets('to ChannelNarrow, mandatory topics with non-empty topic', (tester) async {
+      final narrow = ChannelNarrow(channel.streamId);
+      await prepare(tester, narrow: narrow,
+        mandatoryTopics: true);
+      await enterTopic(tester, narrow: narrow, topic: 'new topic');
+      await tester.pump();
+      checkComposeBoxHintTexts(tester,
+        topicHintText: 'Topic',
+        contentHintText: 'Message #${channel.name} > new topic');
+    });
+
     testWidgets('to TopicNarrow', (tester) async {
       await prepare(tester,
         narrow: TopicNarrow(channel.streamId, TopicName('topic')));
