Skip to content

Add unread_msgs structure to index #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Add unread_msgs structure to index #497

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
610499d
model: Handle read events for indexed messages.
kaustubh-nair Mar 8, 2020
714c60e
helper: Add unread_msg_ids datastructure to index.
kaustubh-nair Mar 8, 2020
f435a4f
model: Update index when marking message as read.
kaustubh-nair Mar 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 67 additions & 2 deletions tests/model/test_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1145,13 +1145,15 @@ def test_update_reaction_remove_reaction(self, mocker, model, response,

def test_update_star_status_no_index(self, mocker, model):
model.index = dict(messages={}) # Not indexed
event = dict(messages=[1], flag='starred', all=False)
event = dict(messages=[1], flag='starred', all=False, operation='add')
mocker.patch('zulipterminal.model.Model.update_rendered_view')
set_count = mocker.patch('zulipterminal.model.set_count')

model.update_message_flag_status(event)

assert model.index == dict(messages={})
model.update_rendered_view.assert_not_called()
set_count.assert_not_called()

def test_update_star_status_invalid_operation(self, mocker, model):
model.index = dict(messages={1: {'flags': None}}) # Minimal
Expand All @@ -1163,9 +1165,11 @@ def test_update_star_status_invalid_operation(self, mocker, model):
'all': False,
}
mocker.patch('zulipterminal.model.Model.update_rendered_view')
set_count = mocker.patch('zulipterminal.model.set_count')
with pytest.raises(RuntimeError):
model.update_message_flag_status(event)
model.update_rendered_view.assert_not_called()
set_count.assert_not_called()

@pytest.mark.parametrize('event_message_ids, indexed_ids', [
([1], [1]),
Expand Down Expand Up @@ -1199,19 +1203,80 @@ def test_update_star_status(self, mocker, model, event_op,
'all': False,
}
mocker.patch('zulipterminal.model.Model.update_rendered_view')
set_count = mocker.patch('zulipterminal.model.set_count')

model.update_message_flag_status(event)

changed_ids = set(indexed_ids) & set(event_message_ids)
for changed_id in changed_ids:
assert model.index['messages'][changed_id]['flags'] == flags_after
(model.update_rendered_view.
has_calls([mocker.call(changed_id) for changed_id in changed_ids]))
assert_has_calls([mocker.call(changed_id)
for changed_id in changed_ids]))

for unchanged_id in (set(indexed_ids) - set(event_message_ids)):
assert (model.index['messages'][unchanged_id]['flags'] ==
flags_before)

set_count.assert_not_called()

@pytest.mark.parametrize('event_message_ids, indexed_ids', [
([1], [1]),
([1, 2], [1]),
([1, 2], [1, 2]),
([1], [1, 2]),
([], [1, 2]),
([1, 2], []),
])
@pytest.mark.parametrize('event_op, flags_before, flags_after', [
('add', [], ['read']),
('add', ['read'], ['read']),
('add', ['starred'], ['starred', 'read']),
('add', ['read', 'starred'], ['read', 'starred']),
('remove', [], []),
('remove', ['read'], ['read']), # msg cannot be marked 'unread'
('remove', ['starred'], ['starred']),
('remove', ['starred', 'read'], ['starred', 'read']),
('remove', ['read', 'starred'], ['read', 'starred']),
])
def test_update_read_status(self, mocker, model, event_op,
event_message_ids, indexed_ids,
flags_before, flags_after):
model.index = dict(messages={msg_id: {'flags': flags_before}
for msg_id in indexed_ids})
event = {
'messages': event_message_ids,
'type': 'update_message_flags',
'flag': 'read',
'operation': event_op,
'all': False,
}

mocker.patch('zulipterminal.model.Model.update_rendered_view')
set_count = mocker.patch('zulipterminal.model.set_count')

model.update_message_flag_status(event)

changed_ids = set(indexed_ids) & set(event_message_ids)
for changed_id in changed_ids:
assert model.index['messages'][changed_id]['flags'] == flags_after

if event_op == 'add':
model.update_rendered_view.assert_has_calls(
[mocker.call(changed_id)])
elif event_op == 'remove':
model.update_rendered_view.assert_not_called()

for unchanged_id in (set(indexed_ids) - set(event_message_ids)):
assert (model.index['messages'][unchanged_id]['flags'] ==
flags_before)

if event_op == 'add':
set_count.assert_called_once_with(list(changed_ids),
self.controller, -1)
elif event_op == 'remove':
set_count.assert_not_called()

@pytest.mark.parametrize('narrow, event, called', [
# Not in PM Narrow
([], {}, False),
Expand Down
11 changes: 8 additions & 3 deletions zulipterminal/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,6 @@ def mark_message_ids_as_read(self, id_list: List[int]) -> None:
'flag': 'read',
'op': 'add',
})
set_count(id_list, self.controller, -1) # FIXME Update?

def send_private_message(self, recipients: str,
content: str) -> bool:
Expand Down Expand Up @@ -811,9 +810,11 @@ def update_message_flag_status(self, event: Event) -> None:
if event['all']: # FIXME Should handle eventually
return

# TODO: Expand from 'starred' to also support 'read' flag changes?
flag_to_change = event['flag']
if flag_to_change != 'starred':
if flag_to_change not in {'starred', 'read'}:
return

if flag_to_change == 'read' and event['operation'] == 'remove':
return

indexed_message_ids = set(self.index['messages'])
Expand All @@ -833,6 +834,10 @@ def update_message_flag_status(self, event: Event) -> None:
self.index['messages'][message_id] = msg
self.update_rendered_view(message_id)

if event['operation'] == 'add' and flag_to_change == 'read':
set_count(list(message_ids_to_mark & indexed_message_ids),
self.controller, -1)

def update_rendered_view(self, msg_id: int) -> None:
# Update new content in the rendered view
for msg_w in self.msg_list.log:
Expand Down