Typing Indicator Animation

[Rohitth007]

This commit animates the typing feedback using an iterable cycle
object. This is done using an asynchronous function
_show_typing_animation and a boolean is_recipient_typing to
start and end the animation.

The corner case of not recieving a stop signal is handled by
setting TYPING_STARTED_EXPIRY_PERIOD=15 and checking this
condition using datetime.

This has to be handled differently from #915 as footer keep updating every half second
so, footer text's duration variable can't be used.

Tests added.

[preetmishra]

@Rohitth007 Thanks for putting this forward! While this is a small addition, this does seem to improve the experience.

I have tested this locally and it seems to work well. 👍

Other than the in-line comments, there are a few things that be improved:

• We follow a particular convention for the commit messages. You can read the commit guidelines that we have in the README and also $ git log --oneline. I would recommend to you install gitlint.
• We would appreciate some tests to go along with the feature. Tests give us the ability to ship new features confidently.
• We use mypy for static type checking. Please add type annotation wherever needed.

Feel free to drop a message in #zulip-terminal if you need any assistance with anything.

[Rohitth007]

@preetmishra Yes, I am aware of the things specified that I have not added yet. This is just a functional prototype and since it's small enough to understand, I was planning to write a proper commit structure after making those changes. I am in between my exams right now hence the not so perfect PR. Hope you understand :)

[preetmishra]

@Rohitth007 No worries. Best of luck with the exams!

[Rohitth007]

@preetmishra PR updated for review

[preetmishra]

@Rohitth007 Hey, thanks for your work! I have given quick feedback on the approach. Let's discuss it before moving ahead for another review iteration.

[Rohitth007]

@preetmishra I have made a few more changes to handle corner cases better. Even the tests work better now. (I have moved time forward instead of reducing it)
It all works but PEP8 tells me that there is a trailing whitespace error on a line I haven't even touched.
I even tried using VSCode's Trim Trailing Whitespace command.
zulipterminal/model.py:960:68: W291 trailing whitespace

[Rohitth007]

@zulipbot add "PR needs review"
@zulipbot remove "PR awaiting update"

[zee-bit]

It all works but PEP8 tells me that there is a trailing whitespace error on a line I haven't even touched.

You did change that line. You can take a look at the Files changed tab of this PR and notice that line 960 is changed. You may be in a subsequent commit while running the linter and thought that you didn't change that line. 😅
(That's why it's important to run tests for each commit so that you find your mistakes in that commit itself.)

PRO-TIP: git blame can prove really helpful in finding out who changed a particular line in a repository.

[Rohitth007]

@zee-bit Oh wait I was checking in a different file 😅 , I mistook model.py for test_model.py cause that was the only file I was editing at that time. 🤦
Yes, I use something similar to git blame 👍

[Ezio-Sarthak]

Thanks for continuing work on this! Leaving some minor code-wise comments 👍

The commit title could be improved a bit, something more specific?

[preetmishra]

@Rohitth007 Thanks for the improvements! This seems to work well locally. 👍

The implementation looks good! I have left a few in-line comments. We could have another test for last_updated_time case.

[Rohitth007]

@preetmishra This is ready for another review.

[zulipbot]

Heads up @Rohitth007, we just merged some commits that conflict with the changes you made in this pull request! You can review this repository's recent commits to see where the conflicts occur. Please rebase your feature branch against the upstream/main branch and resolve your pull request's merge conflicts accordingly.