Skip to content

Commit f5f495b

Browse files
oxlingoxling
committed
msglist: Handle updated events in MessageListView (zulip#118).
Processes an UpdateMessageEvent and hands it off to the MessageListView to update, if the message is visible in the MessageListView. This completes the changes required for issue zulip#118.
1 parent 2465701 commit f5f495b

File tree

5 files changed

+217
-6
lines changed

5 files changed

+217
-6
lines changed

‎lib/api/model/model.dart

+4-4
Original file line numberDiff line numberDiff line change
@@ -250,13 +250,13 @@ class Subscription {
250250
sealed class Message {
251251
final String? avatarUrl;
252252
final String client;
253-
final String content;
253+
String content;
254254
final String contentType;
255255

256256
// final List<MessageEditHistory> editHistory; // TODO handle
257257
final int id;
258-
final bool isMeMessage;
259-
final int? lastEditTimestamp;
258+
bool isMeMessage;
259+
int? lastEditTimestamp;
260260

261261
// final List<Reaction> reactions; // TODO handle
262262
final int recipientId;
@@ -271,7 +271,7 @@ sealed class Message {
271271

272272
// final List<TopicLink> topicLinks; // TODO handle
273273
// final string type; // handled by runtime type of object
274-
final List<String> flags; // TODO enum
274+
List<String> flags; // TODO enum
275275
final String? matchContent;
276276
final String? matchSubject;
277277

‎lib/model/message_list.dart

+63
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
import 'package:collection/collection.dart';
12
import 'package:flutter/foundation.dart';
23

4+
import '../api/model/events.dart';
35
import '../api/model/model.dart';
46
import '../api/route/messages.dart';
57
import 'content.dart';
@@ -86,6 +88,67 @@ class MessageListView extends ChangeNotifier {
8688
notifyListeners();
8789
}
8890

91+
applyChangesToMessage(UpdateMessageEvent event, Message message) {
92+
if (event.renderingOnly != null && event.renderingOnly == true) {
93+
//TODO update inline preview
94+
return;
95+
}
96+
97+
if (!event.flags.equals(message.flags)) {
98+
message.flags = event.flags;
99+
}
100+
101+
if (event.renderedContent != null) {
102+
assert(message.contentType == 'text/html', "Expected message to have html contentType. Instead, got ${message.contentType}");
103+
message.content = event.renderedContent!;
104+
}
105+
106+
if (event.editTimestamp != null) {
107+
message.lastEditTimestamp = event.editTimestamp;
108+
}
109+
110+
if (event.isMeMessage != null) {
111+
message.isMeMessage = event.isMeMessage!;
112+
}
113+
114+
}
115+
116+
///This is almost directly copied from package:collection/algorithms.dart.
117+
///The way that package was set up doesn't allow us to search
118+
///for a message ID among a bunch of message objects - this is a quick
119+
///modification of that method to work here for us.
120+
int findMessageWithId(int messageId) {
121+
var min = 0;
122+
var max = messages.length;
123+
124+
while (min < max) {
125+
var mid = min + ((max - min) >> 1);
126+
Message message = messages[mid];
127+
var comp = message.id.compareTo(messageId);
128+
if (comp == 0) return mid;
129+
if (comp < 0) {
130+
min = mid + 1;
131+
} else {
132+
max = mid;
133+
}
134+
}
135+
return -1;
136+
}
137+
138+
void maybeUpdateMessage(UpdateMessageEvent event) {
139+
int idx = findMessageWithId(event.messageId);
140+
141+
if (idx == -1) {
142+
return;
143+
}
144+
145+
Message message = messages[idx];
146+
applyChangesToMessage(event, message);
147+
148+
contents[idx] = parseContent(message.content);
149+
notifyListeners();
150+
}
151+
89152
/// Called when the app is reassembled during debugging, e.g. for hot reload.
90153
///
91154
/// This will redo from scratch any computations we can, such as parsing

‎lib/model/store.dart

+3-1
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,9 @@ class PerAccountStore extends ChangeNotifier {
272272
}
273273
} else if (event is UpdateMessageEvent) {
274274
assert(debugLog("server event: update_message ${event.messageId}"));
275-
// TODO handle
275+
for (final view in _messageListViews) {
276+
view.maybeUpdateMessage(event);
277+
}
276278
} else if (event is DeleteMessageEvent) {
277279
assert(debugLog("server event: delete_message ${event.messageIds}"));
278280
// TODO handle

‎test/example_data.dart

+2-1
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ StreamMessage streamMessage({
127127
String? topic,
128128
String? content,
129129
String? contentMarkdown,
130+
List<String>? flags,
130131
}) {
131132
final effectiveStream = stream ?? _stream();
132133
// The use of JSON here is convenient in order to delegate parts of the data
@@ -140,7 +141,7 @@ StreamMessage streamMessage({
140141
..._messagePropertiesFromContent(content, contentMarkdown),
141142
'display_recipient': effectiveStream.name,
142143
'stream_id': effectiveStream.streamId,
143-
'flags': [],
144+
'flags': flags ?? [],
144145
'id': id ?? 1234567, // TODO generate example IDs
145146
'subject': topic ?? 'example topic',
146147
'timestamp': 1678139636,

‎test/model/message_list_test.dart

+145
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
import 'package:checks/checks.dart';
2+
import 'package:test/scaffolding.dart';
3+
import 'package:zulip/api/model/events.dart';
4+
import 'package:zulip/api/model/model.dart';
5+
import 'package:zulip/api/route/messages.dart';
6+
import 'package:zulip/model/message_list.dart';
7+
import 'package:zulip/model/narrow.dart';
8+
import 'package:zulip/model/store.dart';
9+
import '../api/fake_api.dart';
10+
import '../model/binding.dart';
11+
import '../model/test_store.dart';
12+
import '../example_data.dart' as eg;
13+
14+
const int userId = 1;
15+
const int streamId = 2;
16+
17+
Future<PerAccountStore> setupStore(ZulipStream stream) async {
18+
await TestZulipBinding.instance.globalStore.add(eg.selfAccount, eg.initialSnapshot());
19+
PerAccountStore store = await TestZulipBinding.instance.globalStore.perAccount(eg.selfAccount.id);
20+
store.addUser(eg.user(userId: userId));
21+
store.addStream(stream);
22+
return store;
23+
}
24+
25+
Future<MessageListView> messageListViewWithMessages(List<Message> messages, PerAccountStore store, Narrow narrow) async {
26+
MessageListView messageList = MessageListView.init(store: store, narrow: narrow);
27+
28+
final connection = store.connection as FakeApiConnection;
29+
30+
connection.prepare(json: GetMessagesResult(
31+
anchor: messages.first.id,
32+
foundNewest: true,
33+
foundOldest: true,
34+
foundAnchor: true,
35+
historyLimited: false,
36+
messages: messages,
37+
).toJson());
38+
39+
await messageList.fetch();
40+
41+
check(messageList.messages.length).equals(messages.length);
42+
43+
return messageList;
44+
}
45+
46+
void main() async {
47+
TestZulipBinding.ensureInitialized();
48+
const narrow = StreamNarrow(streamId);
49+
50+
final ZulipStream stream = eg.stream(streamId: streamId);
51+
PerAccountStore store = await setupStore(stream);
52+
53+
group('update message tests', () {
54+
55+
test('find message in message list returns index of message', () async {
56+
Message m1 = eg.streamMessage(id: 792, stream: stream);
57+
Message m2 = eg.streamMessage(id: 793, stream: stream);
58+
Message m3 = eg.streamMessage(id: 794, stream: stream);
59+
60+
MessageListView messageList = await messageListViewWithMessages([m1, m2, m3], store, narrow);
61+
62+
int idx = messageList.findMessageWithId(793);
63+
check(idx).equals(1);
64+
65+
idx = messageList.findMessageWithId(999);
66+
check(idx).equals(-1);
67+
});
68+
69+
test('update events are correctly applied to message when it is in the stream', () async {
70+
String oldContent = "<p>Hello, world</p>";
71+
String newContent = "<p>Hello, edited</p>";
72+
int newTimestamp = 99999;
73+
74+
List<String> oldFlags = [];
75+
List<String> newFlags = ["starred"];
76+
77+
Message mockMessage = eg.streamMessage(id: 243, stream: stream, content: oldContent, flags: oldFlags);
78+
MessageListView messageList = await messageListViewWithMessages([mockMessage], store, narrow);
79+
80+
UpdateMessageEvent updateEvent = UpdateMessageEvent(
81+
id: 1,
82+
messageId: mockMessage.id,
83+
messageIds: [mockMessage.id],
84+
flags: newFlags,
85+
renderedContent: newContent,
86+
editTimestamp: newTimestamp,
87+
isMeMessage: true
88+
);
89+
90+
Message message = messageList.messages[0];
91+
check(message.content).equals(oldContent);
92+
check(message.flags).deepEquals(oldFlags);
93+
check(message.isMeMessage).equals(false);
94+
95+
bool listenersNotified = false;
96+
97+
messageList.addListener(() { listenersNotified = true; });
98+
messageList.maybeUpdateMessage(updateEvent);
99+
100+
Message updatedMessage = messageList.messages[0];
101+
check(updatedMessage).identicalTo(message);
102+
check(listenersNotified).equals(true);
103+
104+
check(message.content).equals(newContent);
105+
check(message.lastEditTimestamp).equals(newTimestamp);
106+
check(message.flags).deepEquals(newFlags);
107+
check(message.isMeMessage).equals(true);
108+
109+
});
110+
111+
test('update event is ignored when message is not in the message list', () async {
112+
String oldContent = "<p>Hello, world</p>";
113+
String newContent = "<p>Hello, edited</p>";
114+
int newTimestamp = 99999;
115+
116+
Message mockMessage = eg.streamMessage(id: 243, stream: stream, content: oldContent);
117+
MessageListView messageList = await messageListViewWithMessages([mockMessage], store, narrow);
118+
119+
UpdateMessageEvent updateEvent = UpdateMessageEvent(
120+
id: 1,
121+
messageId: 972,
122+
messageIds: [972],
123+
flags: mockMessage.flags,
124+
renderedContent: newContent,
125+
editTimestamp: newTimestamp,
126+
);
127+
128+
Message message = messageList.messages[0];
129+
check(message.content).equals(oldContent);
130+
131+
bool listenersNotified = false;
132+
133+
messageList.addListener(() { listenersNotified = true; });
134+
messageList.maybeUpdateMessage(updateEvent);
135+
136+
Message updatedMessage = messageList.messages[0];
137+
138+
check(listenersNotified).equals(false);
139+
check(updatedMessage).identicalTo(message);
140+
check(message.content).equals(oldContent);
141+
142+
});
143+
144+
});
145+
}

0 commit comments

Comments
 (0)