zulip/zulip-terminal

Refactor index to better support unread messages

Open

#496 opened on Jan 27, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (352 forks)github user discovery
help wanted

Repository metrics

Stars
 (853 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently, very few unread messages are retrieved during initial load. Due to lack of data about unread messages, issues like #434 cannot be solved. Solution is to:

Use the unread message data from model.initial_data['unread_msgs'] from server. Add data structures to the index to store info about unread messages, and to prevent retrieval being costly. When marking message as read, remove the message from the newly added data structure For more info, refer to https://chat.zulip.org/#narrow/stream/206-zulip-terminal/topic/.5BCode.20help.5D.20how.20does.20index.20work.3F

Contributor guide

Research direction
Examine how the index currently stores messages and integrate the unread message data from model.initial data['unread msgs'] into the index, ensuring efficient retrieval and removal upon marking as read.
Tech stack
python
Domain
cli
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55