Skip to content

Commit 20b83a0

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 20b83a0

File tree

4 files changed

+174
-5
lines changed

4 files changed

+174
-5
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

+64
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,68 @@ 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+
//TODO Possibly a new @alert on this message. Update alerts.
99+
message.flags = event.flags;
100+
}
101+
102+
if (event.renderedContent != null) {
103+
assert(message.contentType == 'text/html', "Expected message to have html contentType. Instead, got ${message.contentType}");
104+
message.content = event.renderedContent!;
105+
}
106+
107+
if (event.editTimestamp != null) {
108+
message.lastEditTimestamp = event.editTimestamp;
109+
}
110+
111+
if (event.isMeMessage != null) {
112+
message.isMeMessage = event.isMeMessage!;
113+
}
114+
115+
}
116+
117+
///This is almost directly copied from package:collection/algorithms.dart.
118+
///The way that package was set up doesn't allow us to search
119+
///for a message ID among a bunch of message objects - this is a quick
120+
///modification of that method to work here for us.
121+
int findMessageWithId(int messageId) {
122+
var min = 0;
123+
var max = messages.length;
124+
125+
while (min < max) {
126+
var mid = min + ((max - min) >> 1);
127+
Message message = messages[mid];
128+
var comp = message.id.compareTo(messageId);
129+
if (comp == 0) return mid;
130+
if (comp < 0) {
131+
min = mid + 1;
132+
} else {
133+
max = mid;
134+
}
135+
}
136+
return -1;
137+
}
138+
139+
void maybeUpdateMessage(UpdateMessageEvent event) {
140+
int idx = findMessageWithId(event.messageId);
141+
142+
if (idx == -1) {
143+
return;
144+
}
145+
146+
Message message = messages[idx];
147+
applyChangesToMessage(event, message);
148+
149+
contents[idx] = parseContent(message.content);
150+
notifyListeners();
151+
}
152+
89153
/// Called when the app is reassembled during debugging, e.g. for hot reload.
90154
///
91155
/// 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/model/message_list_test.dart

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
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+
void main() async {
26+
TestZulipBinding.ensureInitialized();
27+
const narrow = StreamNarrow(streamId);
28+
29+
final ZulipStream stream = eg.stream(streamId: streamId);
30+
PerAccountStore store = await setupStore(stream);
31+
32+
group('update message tests', () {
33+
34+
test('find message in message list returns index of message', () async {
35+
MessageListView messageList = MessageListView.init(store: store, narrow: narrow);
36+
37+
final connection = store.connection as FakeApiConnection;
38+
Message m1 = eg.streamMessage(id: 792, stream: stream);
39+
Message m2 = eg.streamMessage(id: 793, stream: stream);
40+
Message m3 = eg.streamMessage(id: 794, stream: stream);
41+
42+
connection.prepare(json: GetMessagesResult(
43+
anchor: m1.id,
44+
foundNewest: true,
45+
foundOldest: true,
46+
foundAnchor: true,
47+
historyLimited: false,
48+
messages: [m1, m2, m3],
49+
).toJson());
50+
51+
await messageList.fetch();
52+
53+
check(messageList.messages.length).equals(3);
54+
55+
int idx = messageList.findMessageWithId(793);
56+
check(idx).equals(1);
57+
58+
idx = messageList.findMessageWithId(999);
59+
check(idx).equals(-1);
60+
});
61+
62+
test('update events are correctly applied to message', () async {
63+
MessageListView messageList = MessageListView.init(store: store, narrow: narrow);
64+
65+
final connection = store.connection as FakeApiConnection;
66+
String oldContent = "<p>Hello, world</p>";
67+
String newContent = "<p>Hello, edited</p>";
68+
int newTimestamp = 99999;
69+
70+
Message m = eg.streamMessage(id: 243, stream: stream, content: oldContent);
71+
connection.prepare(json: GetMessagesResult(
72+
anchor: m.id,
73+
foundNewest: true,
74+
foundOldest: true,
75+
foundAnchor: true,
76+
historyLimited: false,
77+
messages: [m],
78+
).toJson());
79+
80+
await messageList.fetch();
81+
82+
UpdateMessageEvent updateEvent = UpdateMessageEvent(
83+
id: 1,
84+
messageId: m.id,
85+
messageIds: [m.id],
86+
flags: m.flags,
87+
renderedContent: newContent,
88+
editTimestamp: newTimestamp
89+
);
90+
91+
Message oldMessage = messageList.messages[0];
92+
check(oldMessage.content).equals(oldContent);
93+
94+
messageList.maybeUpdateMessage(updateEvent);
95+
96+
Message updatedMessage = messageList.messages[0];
97+
98+
check(updatedMessage.content).equals(newContent);
99+
check(updatedMessage.lastEditTimestamp).equals(newTimestamp);
100+
101+
});
102+
});
103+
}

0 commit comments

Comments
 (0)