Skip to content

Commit d6144bb

Browse files
oxlingoxling
committed
msglist: Handle updated events in MessageListView (#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 #118.
1 parent 2465701 commit d6144bb

File tree

6 files changed

+321
-6
lines changed

6 files changed

+321
-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

+68
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,72 @@ class MessageListView extends ChangeNotifier {
8688
notifyListeners();
8789
}
8890

91+
_applyChangesToMessage(UpdateMessageEvent event, Message message) {
92+
//In earlier server versions, omitting the userId indicates that this is a rendering-only update.
93+
//That means this change was initiated by the server, not the user.
94+
final isRenderingOnly = (event.renderingOnly != null && event.renderingOnly == true) ||
95+
event.userId == null;
96+
97+
if (event.editTimestamp != null && !isRenderingOnly) {
98+
//Only update the timestamp if this was a user-led update,
99+
//not a server-only update
100+
message.lastEditTimestamp = event.editTimestamp;
101+
}
102+
103+
if (!event.flags.equals(message.flags)) {
104+
message.flags = event.flags;
105+
}
106+
107+
if (event.renderedContent != null) {
108+
assert(message.contentType == 'text/html', "Expected message to have html contentType. Instead, got ${message.contentType}");
109+
message.content = event.renderedContent!;
110+
}
111+
112+
if (event.isMeMessage != null) {
113+
message.isMeMessage = event.isMeMessage!;
114+
}
115+
116+
}
117+
118+
//This is almost directly copied from package:collection/src/algorithms.dart.
119+
//The way that package was set up doesn't allow us to search
120+
//for a message ID among a bunch of message objects - this is a quick
121+
//modification of that method to work here for us.
122+
@visibleForTesting
123+
int findMessageWithId(int messageId) {
124+
var min = 0;
125+
var max = messages.length;
126+
127+
while (min < max) {
128+
var mid = min + ((max - min) >> 1);
129+
final message = messages[mid];
130+
var comp = message.id.compareTo(messageId);
131+
if (comp == 0) return mid;
132+
if (comp < 0) {
133+
min = mid + 1;
134+
} else {
135+
max = mid;
136+
}
137+
}
138+
return -1;
139+
}
140+
141+
/// Updates the content of [message] if it is in this view,
142+
/// after we get a [UpdateMessageEvent].
143+
void maybeUpdateMessage(UpdateMessageEvent event) {
144+
final idx = findMessageWithId(event.messageId);
145+
146+
if (idx == -1) {
147+
return;
148+
}
149+
150+
final message = messages[idx];
151+
_applyChangesToMessage(event, message);
152+
153+
contents[idx] = parseContent(message.content);
154+
notifyListeners();
155+
}
156+
89157
/// Called when the app is reassembled during debugging, e.g. for hot reload.
90158
///
91159
/// 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/api/model/model_checks.dart

+3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ extension MessageChecks on Subject<Message> {
99
}
1010

1111
Subject<List<String>> get flags => has((e) => e.flags, 'flags');
12+
Subject<String> get content => has((e) => e.content, 'content');
13+
Subject<bool> get isMeMessage => has((e) => e.isMeMessage, 'isMeMessage');
14+
Subject<int?> get lastEditTimestamp => has((e) => e.lastEditTimestamp, 'lastEditTimestamp');
1215

1316
// TODO accessors for other fields
1417
}

‎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

+241
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
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 '../api/model/model_checks.dart';
11+
import '../model/binding.dart';
12+
import '../model/test_store.dart';
13+
import '../example_data.dart' as eg;
14+
15+
const int userId = 1;
16+
const int streamId = 2;
17+
18+
Future<PerAccountStore> setupStore(ZulipStream stream) async {
19+
addTearDown(TestZulipBinding.instance.reset);
20+
21+
await TestZulipBinding.instance.globalStore.add(eg.selfAccount, eg.initialSnapshot());
22+
23+
final store = await TestZulipBinding.instance.globalStore.perAccount(eg.selfAccount.id);
24+
store.addUser(eg.user(userId: userId));
25+
store.addStream(stream);
26+
27+
return store;
28+
}
29+
30+
Future<MessageListView> messageListViewWithMessages(List<Message> messages, PerAccountStore store, Narrow narrow) async {
31+
final messageList = MessageListView.init(store: store, narrow: narrow);
32+
33+
final connection = store.connection as FakeApiConnection;
34+
35+
connection.prepare(json: GetMessagesResult(
36+
anchor: messages.first.id,
37+
foundNewest: true,
38+
foundOldest: true,
39+
foundAnchor: true,
40+
historyLimited: false,
41+
messages: messages,
42+
).toJson());
43+
44+
await messageList.fetch();
45+
46+
check(messageList.messages.length).equals(messages.length);
47+
48+
return messageList;
49+
}
50+
51+
void main() async {
52+
TestZulipBinding.ensureInitialized();
53+
54+
const narrow = StreamNarrow(streamId);
55+
final stream = eg.stream(streamId: streamId);
56+
57+
group('update message tests', () {
58+
59+
test('find message in message list returns index of message', () async {
60+
final store = await setupStore(stream);
61+
62+
final m1 = eg.streamMessage(id: 2, stream: stream);
63+
final m2 = eg.streamMessage(id: 4, stream: stream);
64+
final m3 = eg.streamMessage(id: 6, stream: stream);
65+
66+
final messageList = await messageListViewWithMessages([m1, m2, m3], store, narrow);
67+
//The implementation of this uses a binary search, so let's test it
68+
//a bit more exhaustively.
69+
70+
//Before the first element
71+
var idx = messageList.findMessageWithId(1);
72+
check(idx).equals(-1);
73+
74+
//Is the first element
75+
idx = messageList.findMessageWithId(2);
76+
check(idx).equals(0);
77+
78+
//Between first and second
79+
idx = messageList.findMessageWithId(3);
80+
check(idx).equals(-1);
81+
82+
//Is the second
83+
idx = messageList.findMessageWithId(4);
84+
check(idx).equals(1);
85+
86+
//Between second and third
87+
idx = messageList.findMessageWithId(5);
88+
check(idx).equals(-1);
89+
90+
//Is the third
91+
idx = messageList.findMessageWithId(6);
92+
check(idx).equals(2);
93+
94+
//After the third
95+
idx = messageList.findMessageWithId(7);
96+
check(idx).equals(-1);
97+
98+
//Invalid IDs
99+
idx = messageList.findMessageWithId(-8409);
100+
check(idx).equals(-1);
101+
102+
idx = messageList.findMessageWithId(0);
103+
check(idx).equals(-1);
104+
});
105+
106+
test('update events are correctly applied to message when it is in the stream', () async {
107+
final store = await setupStore(stream);
108+
109+
const oldContent = "<p>Hello, world</p>";
110+
const newContent = "<p>Hello, edited</p>";
111+
const newTimestamp = 99999;
112+
113+
List<String> oldFlags = [];
114+
List<String> newFlags = ["starred"];
115+
116+
final mockMessage = eg.streamMessage(id: 243, stream: stream, content: oldContent, flags: oldFlags);
117+
final messageList = await messageListViewWithMessages([mockMessage], store, narrow);
118+
119+
final updateEvent = UpdateMessageEvent(
120+
id: 1,
121+
messageId: mockMessage.id,
122+
messageIds: [mockMessage.id],
123+
flags: newFlags,
124+
renderedContent: newContent,
125+
editTimestamp: newTimestamp,
126+
isMeMessage: true,
127+
userId: userId
128+
);
129+
130+
final message = messageList.messages[0];
131+
check(message)
132+
..content.equals(oldContent)
133+
..flags.deepEquals(oldFlags)
134+
..isMeMessage.equals(false);
135+
136+
var listenersNotified = false;
137+
138+
messageList.addListener(() { listenersNotified = true; });
139+
messageList.maybeUpdateMessage(updateEvent);
140+
141+
final updatedMessage = messageList.messages[0];
142+
check(updatedMessage).identicalTo(message);
143+
check(listenersNotified).equals(true);
144+
145+
check(message)
146+
..content.equals(newContent)
147+
..lastEditTimestamp.equals(newTimestamp)
148+
..flags.equals(newFlags)
149+
..isMeMessage.equals(true);
150+
});
151+
152+
test('update event is ignored when message is not in the message list', () async {
153+
final store = await setupStore(stream);
154+
155+
const oldContent = "<p>Hello, world</p>";
156+
const newContent = "<p>Hello, edited</p>";
157+
const newTimestamp = 99999;
158+
159+
final mockMessage = eg.streamMessage(id: 243, stream: stream, content: oldContent);
160+
final messageList = await messageListViewWithMessages([mockMessage], store, narrow);
161+
162+
final updateEvent = UpdateMessageEvent(
163+
id: 1,
164+
messageId: 972,
165+
messageIds: [972],
166+
flags: mockMessage.flags,
167+
renderedContent: newContent,
168+
editTimestamp: newTimestamp,
169+
userId: userId,
170+
);
171+
172+
final message = messageList.messages[0];
173+
check(message).content.equals(oldContent);
174+
175+
var listenersNotified = false;
176+
177+
messageList.addListener(() { listenersNotified = true; });
178+
messageList.maybeUpdateMessage(updateEvent);
179+
180+
check(listenersNotified).equals(false);
181+
check(message).content.equals(oldContent);
182+
183+
});
184+
test('rendering-only update does not change timestamp', () async {
185+
final store = await setupStore(stream);
186+
187+
const oldContent = "<p>Hello, world</p>";
188+
const newContent = "<p>Hello, world</p> <div>Some link preview</div>";
189+
const newTimestamp = 99999;
190+
191+
final mockMessage = eg.streamMessage(id: 972, stream: stream, content: oldContent);
192+
final messageList = await messageListViewWithMessages([mockMessage], store, narrow);
193+
194+
final updateEvent = UpdateMessageEvent(
195+
id: 1,
196+
messageId: 972,
197+
messageIds: [972],
198+
flags: mockMessage.flags,
199+
renderedContent: newContent,
200+
editTimestamp: newTimestamp,
201+
renderingOnly: true,
202+
userId: null,
203+
);
204+
205+
final message = messageList.messages[0];
206+
messageList.maybeUpdateMessage(updateEvent);
207+
check(message)
208+
..content.equals(newContent)
209+
..lastEditTimestamp.isNull();
210+
});
211+
212+
test('rendering-only update does not change timestamp (for old server versions)', () async {
213+
final store = await setupStore(stream);
214+
215+
const oldContent = "<p>Hello, world</p>";
216+
const newContent = "<p>Hello, world</p> <div>Some link preview</div>";
217+
const newTimestamp = 99999;
218+
219+
final mockMessage = eg.streamMessage(id: 972, stream: stream, content: oldContent);
220+
final messageList = await messageListViewWithMessages([mockMessage], store, narrow);
221+
222+
final updateEvent = UpdateMessageEvent(
223+
id: 1,
224+
messageId: 972,
225+
messageIds: [972],
226+
flags: mockMessage.flags,
227+
renderedContent: newContent,
228+
editTimestamp: newTimestamp,
229+
userId: null,
230+
);
231+
232+
final message = messageList.messages[0];
233+
messageList.maybeUpdateMessage(updateEvent);
234+
check(message)
235+
..content.equals(newContent)
236+
..lastEditTimestamp.isNull();
237+
});
238+
239+
240+
});
241+
}

0 commit comments

Comments
 (0)