Skip to content

Commit 0aff6d2

Browse files
PIG208PIG208
committed
api: Make displayName nullable
Signed-off-by: Zixuan James Li <[email protected]>
1 parent 78ccfbc commit 0aff6d2

13 files changed

+19
-39
lines changed

‎lib/api/model/model.dart

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -581,11 +581,7 @@ extension type const TopicName(String _value) {
581581
/// The string this topic is displayed as to the user in our UI.
582582
///
583583
/// At the moment this always equals [apiName].
584-
/// In the future this will become null for the "general chat" topic (#1250),
585-
/// so that UI code can identify when it needs to represent the topic
586-
/// specially in the way prescribed for "general chat".
587-
// TODO(#1250) carry out that plan
588-
String get displayName => _value;
584+
String? get displayName => _value.isEmpty ? null : _value;
589585

590586
/// The key to use for "same topic as" comparisons.
591587
String canonicalize() => apiName.toLowerCase();

‎lib/model/autocomplete.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -942,13 +942,11 @@ class TopicAutocompleteQuery extends AutocompleteQuery {
942942
bool testTopic(TopicName topic, PerAccountStore store) {
943943
// TODO(#881): Sort by match relevance, like web does.
944944

945-
// ignore: unnecessary_null_comparison // null topic names soon to be enabled
946945
if (topic.displayName == null) {
947946
return store.realmEmptyTopicDisplayName.toLowerCase()
948947
.contains(raw.toLowerCase());
949948
}
950949
return topic.displayName != raw
951-
// ignore: unnecessary_non_null_assertion // null topic names soon to be enabled
952950
&& topic.displayName!.toLowerCase().contains(raw.toLowerCase());
953951
}
954952

‎lib/widgets/action_sheet.dart

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -304,9 +304,7 @@ void showTopicActionSheet(BuildContext context, {
304304

305305
// TODO: check for other cases that may disallow this action (e.g.: time
306306
// limit for editing topics).
307-
if (someMessageIdInTopic != null
308-
// ignore: unnecessary_null_comparison // null topic names soon to be enabled
309-
&& topic.displayName != null) {
307+
if (someMessageIdInTopic != null && topic.displayName != null) {
310308
optionButtons.add(ResolveUnresolveButton(pageContext: pageContext,
311309
topic: topic,
312310
someMessageIdInTopic: someMessageIdInTopic));

‎lib/widgets/autocomplete.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -416,13 +416,11 @@ class TopicAutocomplete extends AutocompleteField<TopicAutocompleteQuery, TopicA
416416
@override
417417
Widget buildItem(BuildContext context, int index, TopicAutocompleteResult option) {
418418
final Widget child;
419-
// ignore: unnecessary_null_comparison // null topic names soon to be enabled
420419
if (option.topic.displayName == null) {
421420
final store = PerAccountStoreWidget.of(context);
422421
child = Text(store.realmEmptyTopicDisplayName,
423422
style: const TextStyle(fontStyle: FontStyle.italic));
424423
} else {
425-
// ignore: unnecessary_non_null_assertion // null topic names soon to be enabled
426424
child = Text(option.topic.displayName!);
427425
}
428426

‎lib/widgets/compose_box.dart

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,6 @@ class ComposeTopicController extends ComposeController<TopicValidationError> {
201201
}
202202

203203
void setTopic(TopicName newTopic) {
204-
// ignore: dead_null_aware_expression // null topic names soon to be enabled
205204
value = TextEditingValue(text: newTopic.displayName ?? '');
206205
}
207206
}
@@ -636,7 +635,7 @@ class _StreamContentInputState extends State<_StreamContentInput> {
636635
}
637636

638637
/// The topic name to show in the hint text, or null to show no topic.
639-
String? _hintTopicStr() {
638+
TopicName? _hintTopic() {
640639
if (widget.controller.topic.isTopicVacuous) {
641640
if (widget.controller.topic.mandatory) {
642641
// The chosen topic can't be sent to, so don't show it.
@@ -651,7 +650,7 @@ class _StreamContentInputState extends State<_StreamContentInput> {
651650
}
652651
}
653652

654-
return widget.controller.topic.textNormalized;
653+
return TopicName(widget.controller.topic.textNormalized);
655654
}
656655

657656
@override
@@ -661,15 +660,14 @@ class _StreamContentInputState extends State<_StreamContentInput> {
661660

662661
final streamName = store.streams[widget.narrow.streamId]?.name
663662
?? zulipLocalizations.unknownChannelName;
664-
final hintTopicStr = _hintTopicStr();
665-
final hintDestination = hintTopicStr == null
663+
final hintTopic = _hintTopic();
664+
final hintDestination = hintTopic == null
666665
// No i18n of this use of "#" and ">" string; those are part of how
667666
// Zulip expresses channels and topics, not any normal English punctuation,
668667
// so don't make sense to translate. See:
669668
// https://github.com/zulip/zulip-flutter/pull/1148#discussion_r1941990585
670669
? '#$streamName'
671-
: '#$streamName > '
672-
'${hintTopicStr.isEmpty ? store.realmEmptyTopicDisplayName : hintTopicStr}';
670+
: '#$streamName > ${hintTopic.displayName ?? store.realmEmptyTopicDisplayName}';
673671

674672
return _TypingNotifier(
675673
destination: TopicNarrow(widget.narrow.streamId,
@@ -845,7 +843,6 @@ class _FixedDestinationContentInput extends StatelessWidget {
845843
// Zulip expresses channels and topics, not any normal English punctuation,
846844
// so don't make sense to translate. See:
847845
// https://github.com/zulip/zulip-flutter/pull/1148#discussion_r1941990585
848-
// ignore: dead_null_aware_expression // null topic names soon to be enabled
849846
'#$streamName > ${topic.displayName ?? store.realmEmptyTopicDisplayName}');
850847

851848
case DmNarrow(otherRecipientIds: []): // The self-1:1 thread.

‎lib/widgets/inbox.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -546,14 +546,12 @@ class _TopicItem extends StatelessWidget {
546546
style: TextStyle(
547547
fontSize: 17,
548548
height: (20 / 17),
549-
// ignore: unnecessary_null_comparison // null topic names soon to be enabled
550549
fontStyle: topic.displayName == null ? FontStyle.italic : null,
551550
// TODO(design) check if this is the right variable
552551
color: designVariables.labelMenuButton,
553552
),
554553
maxLines: 2,
555554
overflow: TextOverflow.ellipsis,
556-
// ignore: dead_null_aware_expression // null topic names soon to be enabled
557555
topic.displayName ?? store.realmEmptyTopicDisplayName))),
558556
const SizedBox(width: 12),
559557
if (hasMention) const _IconMarker(icon: ZulipIcons.at_sign),

‎lib/widgets/message_list.dart

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -326,10 +326,8 @@ class MessageListAppBarTitle extends StatelessWidget {
326326
return Row(
327327
mainAxisSize: MainAxisSize.min,
328328
children: [
329-
// ignore: dead_null_aware_expression // null topic names soon to be enabled
330329
Flexible(child: Text(topic.displayName ?? store.realmEmptyTopicDisplayName, style: TextStyle(
331330
fontSize: 13,
332-
// ignore: unnecessary_null_comparison // null topic names soon to be enabled
333331
fontStyle: topic.displayName == null ? FontStyle.italic : null,
334332
).merge(weightVariableTextStyle(context)))),
335333
if (icon != null)
@@ -1144,13 +1142,11 @@ class StreamMessageRecipientHeader extends StatelessWidget {
11441142
child: Row(
11451143
children: [
11461144
Flexible(
1147-
// ignore: dead_null_aware_expression // null topic names soon to be enabled
11481145
child: Text(topic.displayName ?? store.realmEmptyTopicDisplayName,
11491146
// TODO: Give a way to see the whole topic (maybe a
11501147
// long-press interaction?)
11511148
overflow: TextOverflow.ellipsis,
11521149
style: recipientHeaderTextStyle(context,
1153-
// ignore: unnecessary_null_comparison // null topic names soon to be enabled
11541150
fontStyle: topic.displayName == null ? FontStyle.italic : null,
11551151
))),
11561152
const SizedBox(width: 4),

‎test/api/model/model_checks.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ extension ZulipStreamChecks on Subject<ZulipStream> {
2626

2727
extension TopicNameChecks on Subject<TopicName> {
2828
Subject<String> get apiName => has((x) => x.apiName, 'apiName');
29-
Subject<String> get displayName => has((x) => x.displayName, 'displayName');
29+
Subject<String?> get displayName => has((x) => x.displayName, 'displayName');
3030
}
3131

3232
extension StreamConversationChecks on Subject<StreamConversation> {

‎test/widgets/action_sheet_test.dart

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,6 @@ void main() {
372372
final topicRow = find.descendant(
373373
of: find.byType(ZulipAppBar),
374374
matching: find.text(
375-
// ignore: dead_null_aware_expression // null topic names soon to be enabled
376375
effectiveTopic.displayName ?? eg.defaultRealmEmptyTopicDisplayName));
377376
await tester.longPress(topicRow);
378377
// sheet appears onscreen; default duration of bottom-sheet enter animation
@@ -393,7 +392,7 @@ void main() {
393392

394393
await tester.longPress(find.descendant(
395394
of: find.byType(RecipientHeader),
396-
matching: find.text(effectiveMessage.topic.displayName)));
395+
matching: find.text(effectiveMessage.topic.displayName!)));
397396
// sheet appears onscreen; default duration of bottom-sheet enter animation
398397
await tester.pump(const Duration(milliseconds: 250));
399398
}
@@ -457,7 +456,7 @@ void main() {
457456
messages: [message]);
458457
check(findButtonForLabel('Mark as resolved')).findsNothing();
459458
check(findButtonForLabel('Mark as unresolved')).findsNothing();
460-
}, skip: true); // null topic names soon to be enabled
459+
});
461460

462461
testWidgets('show from recipient header', (tester) async {
463462
await prepare();

‎test/widgets/autocomplete_test.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ void main() {
415415
await tester.tap(find.text('Topic three'));
416416
await tester.pumpAndSettle();
417417
check(tester.widget<TextField>(topicInputFinder).controller!.text)
418-
.equals(topic3.name.displayName);
418+
.equals(topic3.name.displayName!);
419419
check(find.text('Topic one' )).findsNothing();
420420
check(find.text('Topic two' )).findsNothing();
421421
check(find.text('Topic three')).findsOne(); // shown in `_TopicInput` once
@@ -473,7 +473,7 @@ void main() {
473473
await tester.pumpAndSettle();
474474

475475
check(find.text('some display name')).findsOne();
476-
}, skip: true); // null topic names soon to be enabled
476+
});
477477

478478
testWidgets('match realmEmptyTopicDisplayName in autocomplete', (tester) async {
479479
final topic = eg.getStreamTopicsEntry(name: '');
@@ -486,7 +486,7 @@ void main() {
486486
await tester.pumpAndSettle();
487487

488488
check(find.text('general chat')).findsOne();
489-
}, skip: true); // null topic names soon to be enabled
489+
});
490490

491491
testWidgets('autocomplete to realmEmptyTopicDisplayName sets topic to empty string', (tester) async {
492492
final topic = eg.getStreamTopicsEntry(name: '');
@@ -502,6 +502,6 @@ void main() {
502502
await tester.tap(find.text('general chat'));
503503
await tester.pump(Duration.zero);
504504
check(controller.value).text.equals('');
505-
}, skip: true); // null topic names soon to be enabled
505+
});
506506
});
507507
}

‎test/widgets/compose_box_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -563,7 +563,7 @@ void main() {
563563
narrow: TopicNarrow(channel.streamId, TopicName('')));
564564
checkComposeBoxHintTexts(tester, contentHintText:
565565
'Message #${channel.name} > ${eg.defaultRealmEmptyTopicDisplayName}');
566-
}, skip: true); // null topic names soon to be enabled
566+
});
567567
});
568568

569569
testWidgets('to DmNarrow with self', (tester) async {

‎test/widgets/inbox_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ void main() {
314314
subscriptions: [(eg.subscription(channel))],
315315
unreadMessages: [eg.streamMessage(stream: channel, topic: '')]);
316316
check(find.text(eg.defaultRealmEmptyTopicDisplayName)).findsOne();
317-
}, skip: true); // null topic names soon to be enabled
317+
});
318318

319319
group('topic visibility', () {
320320
final channel = eg.stream();

‎test/widgets/message_list_test.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ void main() {
204204
messageCount: 1);
205205
checkAppBarChannelTopic(
206206
channel.name, eg.defaultRealmEmptyTopicDisplayName);
207-
}, skip: true); // null topic names soon to be enabled
207+
});
208208

209209
testWidgets('has channel-feed action for topic narrows', (tester) async {
210210
final pushedRoutes = <Route<void>>[];
@@ -1015,7 +1015,7 @@ void main() {
10151015
await tester.pump();
10161016
check(findInMessageList('stream name')).single;
10171017
check(findInMessageList(eg.defaultRealmEmptyTopicDisplayName)).single;
1018-
}, skip: true); // null topic names soon to be enabled
1018+
});
10191019

10201020
testWidgets('show general chat for empty topics without channel name', (tester) async {
10211021
await setupMessageListPage(tester,
@@ -1024,7 +1024,7 @@ void main() {
10241024
await tester.pump();
10251025
check(findInMessageList('stream name')).isEmpty();
10261026
check(findInMessageList(eg.defaultRealmEmptyTopicDisplayName)).single;
1027-
}, skip: true); // null topic names soon to be enabled
1027+
});
10281028

10291029
testWidgets('show topic visibility icon when followed', (tester) async {
10301030
await setupMessageListPage(tester,

0 commit comments

Comments
 (0)