model: Prevent duplicate flags when processing update_message_flags. #2033
Conversation
sarafarajnasardi
force-pushed
the
fix-duplicate-message-flags
branch
from
6570cf0 to
2197c45
Compare
chrisbobbe
left a comment
chrisbobbe
left a comment
There was a problem hiding this comment.
Thanks! Small comments below.
Also some commit-message nits:
Please keep the body of your commit message word-wrapped to 68 columns.
In this case the Fixes line suffices to explain the change, so you don't need the two paragraphs above that.
Also the Fixes line should read Fixes #1986. (note the period).
test/model/message_test.dart
Outdated
| // Should verify no notifications since no actual change happened | ||
| // But current implementation might notify anyway if it doesn't check for change | ||
| // optimization. The main point is flags list shouldn't have duplicates. | ||
| // Let's check the flags first. |
There was a problem hiding this comment.
I appreciate wanting to explain this 🙂 but I think we can cut this comment; the test is about an edge case that should be rare (in the fetch-event race) and an extra notifyListeners isn't a significant concern here.
sarafarajnasardi
force-pushed
the
fix-duplicate-message-flags
branch
from
2197c45 to
9329d2f
Compare
|
Thanks! I've removed the test comments and updated the commit message formatting |
chrisbobbe
left a comment
chrisbobbe
left a comment
There was a problem hiding this comment.
Thanks! Small comments below, otherwise LGTM.
| if (isAdd && (event as UpdateMessageFlagsAddEvent).all) { | ||
| for (final message in messages.values) { | ||
| message.flags.add(event.flag); | ||
| if (!message.flags.contains(event.flag)) { | ||
| message.flags.add(event.flag); | ||
| } |
There was a problem hiding this comment.
Please also write a test exercising this case.
| test('avoid duplicate flags', () async { | ||
| await prepare(); |
There was a problem hiding this comment.
| test('avoid duplicate flags', () async { | |
| await prepare(); | |
| test('avoid duplicate flags', () async { | |
| // Regression test for https://github.com/zulip/zulip-flutter/issues/1986 | |
| await prepare(); |
There was a problem hiding this comment.
should I add this same comment in new test also?
There was a problem hiding this comment.
Yes, I think so; it's applies equally there.
sarafarajnasardi
force-pushed
the
fix-duplicate-message-flags
branch
from
9329d2f to
9e5f2e9
Compare
|
Done! I have added the new test and your suggested comment. |
sarafarajnasardi
force-pushed
the
fix-duplicate-message-flags
branch
from
9e5f2e9 to
138cd43
Compare
2 participants
Previously, the event handler would unconditionally add flags to the message's flag list. If a flag (like 'read') was already present, this created duplicates, which broke subsequent removal operations.
This commit adds a check to ensure the flag is not already present before adding it, making the operation idempotent.
Fixes #1986