Skip to content

Commit 9a04993

Browse files
PIG208PIG208
committed
narrow: Add starred messages narrow.
"Starred messages narrow" is the user facing name of the narrow, thus we name the Narrow class after it. This narrow is pretty similar to MentionsNarrow. Signed-off-by: Zixuan James Li <[email protected]>
1 parent 1c7367a commit 9a04993

16 files changed

+137
-8
lines changed

‎assets/l10n/app_en.arb

+4
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,10 @@
480480
"@mentionsPageTitle": {
481481
"description": "Title for the page of @-mentions."
482482
},
483+
"starredMessagesPageTitle": "Starred messages",
484+
"@starredMessagesPageTitle": {
485+
"description": "Title for the page of starred messages."
486+
},
483487
"notifGroupDmConversationLabel": "{senderFullName} to you and {numOthers, plural, =1{1 other} other{{numOthers} others}}",
484488
"@notifGroupDmConversationLabel": {
485489
"description": "Label for a group DM conversation notification.",

‎lib/model/autocomplete.dart

+1
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ class MentionAutocompleteView extends ChangeNotifier {
223223
break;
224224
case CombinedFeedNarrow():
225225
case MentionsNarrow():
226+
case StarredMessagesNarrow():
226227
assert(false, 'No compose box, thus no autocomplete is available in ${narrow.runtimeType}.');
227228
}
228229
return (userA, userB) => _compareByRelevance(userA, userB,

‎lib/model/message_list.dart

+3
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
385385
case TopicNarrow():
386386
case DmNarrow():
387387
case MentionsNarrow():
388+
case StarredMessagesNarrow():
388389
return true;
389390
}
390391
}
@@ -401,6 +402,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
401402
case TopicNarrow():
402403
case DmNarrow():
403404
case MentionsNarrow():
405+
case StarredMessagesNarrow():
404406
return true;
405407
}
406408
}
@@ -562,6 +564,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
562564

563565
case CombinedFeedNarrow():
564566
case MentionsNarrow():
567+
case StarredMessagesNarrow():
565568
// The messages were and remain in this narrow.
566569
// TODO(#421): … except they may have become muted or not.
567570
// We'll handle that at the same time as we handle muting itself changing.

‎lib/model/narrow.dart

+22
Original file line numberDiff line numberDiff line change
@@ -321,3 +321,25 @@ class MentionsNarrow extends Narrow {
321321
@override
322322
int get hashCode => 'MentionsNarrow'.hashCode;
323323
}
324+
325+
class StarredMessagesNarrow extends Narrow {
326+
const StarredMessagesNarrow();
327+
328+
@override
329+
ApiNarrow apiEncode() => [ApiNarrowIs(IsOperand.starred)];
330+
331+
@override
332+
bool containsMessage(Message message) {
333+
return message.flags.contains(MessageFlag.starred);
334+
}
335+
336+
@override
337+
bool operator ==(Object other) {
338+
if (other is! StarredMessagesNarrow) return false;
339+
// Conceptually there's only one value of this type.
340+
return true;
341+
}
342+
343+
@override
344+
int get hashCode => 'StarredMessagesNarrow'.hashCode;
345+
}

‎lib/model/unreads.dart

+5
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,9 @@ class Unreads extends ChangeNotifier {
195195

196196
int countInMentionsNarrow() => mentions.length;
197197

198+
// TODO: Implement unreads handling.
199+
int countInStarredMessagesNarrow() => 0;
200+
198201
int countInNarrow(Narrow narrow) {
199202
switch (narrow) {
200203
case CombinedFeedNarrow():
@@ -207,6 +210,8 @@ class Unreads extends ChangeNotifier {
207210
return countInDmNarrow(narrow);
208211
case MentionsNarrow():
209212
return countInMentionsNarrow();
213+
case StarredMessagesNarrow():
214+
return countInStarredMessagesNarrow();
210215
}
211216
}
212217

‎lib/widgets/actions.dart

+3
Original file line numberDiff line numberDiff line change
@@ -141,5 +141,8 @@ Future<void> _legacyMarkNarrowAsRead(BuildContext context, Narrow narrow) async
141141
messages: unreadMentions,
142142
op: UpdateMessageFlagsOp.add,
143143
flag: MessageFlag.read);
144+
case StarredMessagesNarrow():
145+
// TODO: Implement unreads handling.
146+
return;
144147
}
145148
}

‎lib/widgets/compose_box.dart

+2
Original file line numberDiff line numberDiff line change
@@ -1072,6 +1072,7 @@ class ComposeBox extends StatelessWidget {
10721072

10731073
case CombinedFeedNarrow():
10741074
case MentionsNarrow():
1075+
case StarredMessagesNarrow():
10751076
return false;
10761077
}
10771078
}
@@ -1088,6 +1089,7 @@ class ComposeBox extends StatelessWidget {
10881089
return _FixedDestinationComposeBox(key: controllerKey, narrow: narrow);
10891090
case CombinedFeedNarrow():
10901091
case MentionsNarrow():
1092+
case StarredMessagesNarrow():
10911093
return const SizedBox.shrink();
10921094
}
10931095
}

‎lib/widgets/message_list.dart

+5
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ class _MessageListPageState extends State<MessageListPage> implements MessageLis
249249
switch(narrow) {
250250
case CombinedFeedNarrow():
251251
case MentionsNarrow():
252+
case StarredMessagesNarrow():
252253
appBarBackgroundColor = null; // i.e., inherit
253254

254255
case ChannelNarrow(:final streamId):
@@ -338,6 +339,9 @@ class MessageListAppBarTitle extends StatelessWidget {
338339
case MentionsNarrow():
339340
return Text(zulipLocalizations.mentionsPageTitle);
340341

342+
case StarredMessagesNarrow():
343+
return Text(zulipLocalizations.starredMessagesPageTitle);
344+
341345
case ChannelNarrow(:var streamId):
342346
final store = PerAccountStoreWidget.of(context);
343347
final stream = store.streams[streamId];
@@ -835,6 +839,7 @@ class RecipientHeader extends StatelessWidget {
835839
switch (narrow) {
836840
case CombinedFeedNarrow():
837841
case MentionsNarrow():
842+
case StarredMessagesNarrow():
838843
return true;
839844

840845
case ChannelNarrow():

‎test/api/route/messages_test.dart

+3
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ void main() {
191191
checkNarrow(const MentionsNarrow().apiEncode(), jsonEncode([
192192
{'operator': 'is', 'operand': 'mentioned'},
193193
]));
194+
checkNarrow(const StarredMessagesNarrow().apiEncode(), jsonEncode([
195+
{'operator': 'is', 'operand': 'starred'},
196+
]));
194197

195198
checkNarrow([ApiNarrowDm([123, 234])], jsonEncode([
196199
{'operator': 'dm', 'operand': [123, 234]},

‎test/model/autocomplete_test.dart

+7
Original file line numberDiff line numberDiff line change
@@ -676,6 +676,13 @@ void main() {
676676
check(() => MentionAutocompleteView.init(store: store, narrow: narrow))
677677
.throws<AssertionError>();
678678
});
679+
680+
test('StarredMessagesNarrow gives error', () async {
681+
await prepare(users: [eg.user(), eg.user()], messages: []);
682+
const narrow = StarredMessagesNarrow();
683+
check(() => MentionAutocompleteView.init(store: store, narrow: narrow))
684+
.throws<AssertionError>();
685+
});
679686
});
680687

681688
test('final results end-to-end', () async {

‎test/model/compose_test.dart

+8
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,14 @@ hello
239239
.equals(store.realmUrl.resolve('#narrow/is/mentioned/near/1'));
240240
});
241241

242+
test('StarredMessagesNarrow', () {
243+
final store = eg.store();
244+
check(narrowLink(store, const StarredMessagesNarrow()))
245+
.equals(store.realmUrl.resolve('#narrow/is/starred'));
246+
check(narrowLink(store, const StarredMessagesNarrow(), nearMessageId: 1))
247+
.equals(store.realmUrl.resolve('#narrow/is/starred/near/1'));
248+
});
249+
242250
test('ChannelNarrow / TopicNarrow', () {
243251
void checkNarrow(String expectedFragment, {
244252
required int streamId,

‎test/model/message_list_test.dart

+39
Original file line numberDiff line numberDiff line change
@@ -1274,6 +1274,44 @@ void main() {
12741274
check(model.messages.map((m) => m.id)).deepEquals(expected..add(301 + i));
12751275
}
12761276
});
1277+
1278+
test('in StarredMessagesNarrow', () async {
1279+
final stream = eg.stream(streamId: 1, name: 'muted stream');
1280+
const mutedTopic = 'muted';
1281+
await prepare(narrow: const StarredMessagesNarrow());
1282+
await store.addStream(stream);
1283+
await store.addUserTopic(stream, mutedTopic, UserTopicVisibilityPolicy.muted);
1284+
await store.addSubscription(eg.subscription(stream, isMuted: true));
1285+
1286+
List<Message> getMessages(int startingId) => [
1287+
eg.streamMessage(id: startingId,
1288+
stream: stream, topic: mutedTopic, flags: [MessageFlag.starred]),
1289+
eg.dmMessage(id: startingId + 1,
1290+
from: eg.otherUser, to: [eg.selfUser], flags: [MessageFlag.starred]),
1291+
];
1292+
1293+
// Check filtering on fetchInitial…
1294+
await prepareMessages(foundOldest: false, messages: getMessages(201));
1295+
final expected = <int>[];
1296+
check(model.messages.map((m) => m.id))
1297+
.deepEquals(expected..addAll([201, 202]));
1298+
1299+
// … and on fetchOlder…
1300+
connection.prepare(json: olderResult(
1301+
anchor: 201, foundOldest: true, messages: getMessages(101)).toJson());
1302+
await model.fetchOlder();
1303+
checkNotified(count: 2);
1304+
check(model.messages.map((m) => m.id))
1305+
.deepEquals(expected..insertAll(0, [101, 102]));
1306+
1307+
// … and on MessageEvent.
1308+
final messages = getMessages(301);
1309+
for (var i = 0; i < 2; i += 1) {
1310+
await store.handleEvent(MessageEvent(id: 0, message: messages[i]));
1311+
checkNotifiedOnce();
1312+
check(model.messages.map((m) => m.id)).deepEquals(expected..add(301 + i));
1313+
}
1314+
});
12771315
});
12781316

12791317
test('recipient headers are maintained consistently', () async {
@@ -1520,6 +1558,7 @@ void checkInvariants(MessageListView model) {
15201558
case TopicNarrow():
15211559
case DmNarrow():
15221560
case MentionsNarrow():
1561+
case StarredMessagesNarrow():
15231562
}
15241563
}
15251564

‎test/model/narrow_test.dart

+11
Original file line numberDiff line numberDiff line change
@@ -162,4 +162,15 @@ void main() {
162162
eg.streamMessage(flags: [MessageFlag.wildcardMentioned]))).isTrue();
163163
});
164164
});
165+
166+
group('StarredMessagesNarrow', () {
167+
test('containsMessage', () {
168+
const narrow = StarredMessagesNarrow();
169+
170+
check(narrow.containsMessage(
171+
eg.streamMessage(flags: []))).isFalse();
172+
check(narrow.containsMessage(
173+
eg.streamMessage(flags:[MessageFlag.starred]))).isTrue();
174+
});
175+
});
165176
}

‎test/model/unreads_test.dart

+11
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,17 @@ void main() {
227227
]);
228228
check(model.countInMentionsNarrow()).equals(2);
229229
});
230+
231+
test('countInStarredMessagesNarrow', () async {
232+
final stream = eg.stream();
233+
prepare();
234+
await channelStore.addStream(stream);
235+
fillWithMessages([
236+
eg.streamMessage(stream: stream, flags: []),
237+
eg.streamMessage(stream: stream, flags: [MessageFlag.starred]),
238+
]);
239+
check(model.countInStarredMessagesNarrow()).equals(0);
240+
});
230241
});
231242

232243
group('handleMessageEvent', () {

‎test/widgets/action_sheet_test.dart

+3-2
Original file line numberDiff line numberDiff line change
@@ -374,8 +374,9 @@ void main() {
374374

375375
group('composing to reply is not yet supported', () {
376376
final testCases = [
377-
('CombinedFeedNarrow', const CombinedFeedNarrow(), eg.streamMessage()),
378-
('MentionsNarrow', const MentionsNarrow(), eg.streamMessage(flags: [MessageFlag.mentioned])),
377+
('CombinedFeedNarrow', const CombinedFeedNarrow(), eg.streamMessage()),
378+
('MentionsNarrow', const MentionsNarrow(), eg.streamMessage(flags: [MessageFlag.mentioned])),
379+
('StarredMessagesNarrow', const StarredMessagesNarrow(), eg.streamMessage(flags: [MessageFlag.starred])),
379380
];
380381

381382
for (final (narrowName, narrow, message) in testCases) {

‎test/widgets/message_list_test.dart

+10-6
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,9 @@ void main() {
124124
group('presents message content appropriately', () {
125125
// regression test for https://github.com/zulip/zulip-flutter/issues/736
126126
final testCases = [
127-
("Combined feed", const CombinedFeedNarrow(), <MessageFlag>[]),
128-
("MentionsNarrow", const MentionsNarrow(), [MessageFlag.mentioned]),
127+
("Combined feed", const CombinedFeedNarrow(), <MessageFlag>[]),
128+
("MentionsNarrow", const MentionsNarrow(), [MessageFlag.mentioned]),
129+
("StarredMessagesNarrow", const StarredMessagesNarrow(), [MessageFlag.starred]),
129130
];
130131
for (final (narrowName, narrow, flags) in testCases) {
131132
testWidgets('content in $narrowName not asked to consume insets (including bottom)', (tester) async {
@@ -713,11 +714,14 @@ void main() {
713714
group('show channel name conditionally', () {
714715
final mentionedMessage =
715716
eg.streamMessage(stream: stream, topic: 'topic name', flags: [MessageFlag.mentioned]);
717+
final starredMessage =
718+
eg.streamMessage(stream: stream, topic: 'topic name', flags: [MessageFlag.starred]);
716719
final testCases = [
717-
(true, 'CombinedFeedNarrow', const CombinedFeedNarrow(), message),
718-
(true, 'MentionsNarrow', const MentionsNarrow(), mentionedMessage),
719-
(false, 'ChannelNarrow', ChannelNarrow(stream.streamId), message),
720-
(false, 'TopicNarrow', TopicNarrow.ofMessage(message), message)
720+
(true, 'CombinedFeedNarrow', const CombinedFeedNarrow(), message),
721+
(true, 'MentionsNarrow', const MentionsNarrow(), mentionedMessage),
722+
(true, 'StarredMessagesNarrow', const StarredMessagesNarrow(), starredMessage),
723+
(false, 'ChannelNarrow', ChannelNarrow(stream.streamId), message),
724+
(false, 'TopicNarrow', TopicNarrow.ofMessage(message), message)
721725
];
722726

723727
for (final (showChannelName, narrowName, narrow, message) in testCases) {

0 commit comments

Comments
 (0)