User-friendly date and time formatting. #1218

plugyawn · 2022-04-29T20:03:41Z

What does this PR do?
Adds user friendly times to the user and message info views. The current view just includes the timestamp, which is hard to decipher.

Partial fix for issues #1211 and addresses #1086

Tested?

Manually
Existing tests (adapted, if necessary)
New tests added (for any new behavior)
Passed linting & tests (each commit)

Commit flow

first commit adds a helper function to friendly-fy the timestamps.
second commit implements the helper function in views.py for message and user info popups.

Notes & Questions

Interactions

Visual changes
For message info:

For user info:

mounilKshah · 2022-05-02T00:21:00Z

zulipterminal/ui_tools/views.py

@@ -1162,6 +1163,7 @@ def _fetch_user_data(controller: Any, user_id: int) -> Dict[str, Any]:
            }
            return display_data

+        pretty_date = user_friendly_time(data["last_active"])


For users who have been inactive for longer than two weeks, the data["last_active"] is empty. This is causing ZT to crash for such users when I tried running it.

neiljp · 2022-05-04T05:38:28Z

@plugyawn You saw my feedback in the stream, but essentially:

this is unstable right now, at least with the issue @mounilKshah pointed out, as well as for me
actual timestamps rather than formatted dates would likely be more reliable for comparison
tests would make it easier to provide potential buggy inputs and get them working
git commit style could be improved, as we discussed via gitlint.

plugyawn · 2022-05-05T18:48:52Z

@plugyawn You saw my feedback in the stream, but essentially:

this is unstable right now, at least with the issue @mounilKshah pointed out, as well as for me

actual timestamps rather than formatted dates would likely be more reliable for comparison

tests would make it easier to provide potential buggy inputs and get them working

git commit style could be improved, as we discussed via gitlint.

Sorry for the late reply!

@mounilKshah thanks for pointing out the error! I've fixed it.
Agreed, I'll check into that. In this case, though, do you think it'll make much of a difference?
On it! I'll get started with adding tests.
I set up gitlint, hopefully it's working now : )

plugyawn · 2022-05-06T07:11:46Z

@neiljp could you check the commit flow now?

neiljp · 2022-05-06T21:58:38Z

@plugyawn As per discussion in the stream, you really need a rebase (or other adjustment) since you seem to have squashed commits from upstream/main or another PR into one of these commits.

neiljp · 2022-05-13T19:43:50Z

zulipterminal/helper.py

        datetime_object = datetime.strptime(
            time_stamp, "%a %b %d %Y %I:%M:%S %p"
        )  # Fri Apr 29 2022 05:15:12 AM is an example
-    else: # for user_info, year not included
-        if time_stamp[-1] == "M": # AM or PM
+    else:  # for user_info, year not included


We'll want to keep these lint fixes in the commit in which they were introduced. If you do an interactive rebase and edit the previous commit and run make fix, then when you continue the rebase, these changes should likely drop out of this commit (or similarly in later commits, in other complex PRs).

Oh, okay! Didn't know, I'll try it out.

plugyawn · 2022-06-05T02:59:32Z

@mounilKshah @neiljp Could you check this now? I think the changes I made in test_popups.py need to be changed -- but I'm unsure as to what those changes should be.

Also, I've made sure the commits only contain changes in their respective files, as you said. Editing the commits and running commit --amend was the solution, as you said.

mounilKshah

The PR works well, without any glitches and the commit structure is better than when I had last seen. I have left a few comments,

Also, maybe change the name of the branch on your forked repo? It can create confusion while working with multiple PRs.

mounilKshah · 2022-06-08T14:48:27Z

zulipterminal/helper.py

@@ -816,3 +817,61 @@ def open_media(controller: Any, tool: str, media_path: str) -> None:

    if error:
        controller.report_error(error)
+
+
+def user_friendly_time(time_stamp: str) -> str:  # message_info has a different format


Instead of writing what the function does in the commit message, I think it would be more convenient to write it as comments within the function body, so that the next person working on it doesn't have to search for the respective commit(s).

mounilKshah · 2022-06-08T14:50:01Z

zulipterminal/helper.py

+        if seconds < 86400:  # 24 hours
+            return str(seconds // 3600) + " hours ago"
+
+    time_string = ""


The value of time_string is assigned only in the first conditional, but not returned/used anywhere.

This commit adds a function that takes in a datetime string, checks whether it came from message_info or user_info depending on string length (later, we could include a boolean in the arguments. For now, that's an unnecessary variable), and then returns a user-friendly version of the date and time. For example, if the string is "Fri Apr 29 2022 05:15:12 AM", then converted will be something like "A week ago", "43 minutes ago", and so on.

This commit implements the helper function for friendly times to the user and message info pop-ups. It shows up as Fri 4 Apr 11:05:20 PM (A week ago) And so on.

plugyawn · 2022-08-06T03:44:16Z

Reviews incorporated into the PR.

zulipbot · 2024-04-17T23:35:53Z

Heads up @plugyawn, 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.

zulipbot added the size: L [Automatic label added by zulipbot] label Apr 29, 2022

mounilKshah reviewed May 2, 2022

View reviewed changes

neiljp added enhancement New feature or request area: UI General user interface update PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback labels May 4, 2022

plugyawn force-pushed the 290422 branch from 1ff9f30 to 1c93008 Compare May 6, 2022 06:35

zulipbot added size: XL [Automatic label added by zulipbot] and removed size: L [Automatic label added by zulipbot] labels May 6, 2022

plugyawn force-pushed the 290422 branch 2 times, most recently from eefdc96 to 19d8477 Compare May 6, 2022 07:11

plugyawn force-pushed the 290422 branch from 19d8477 to b5d088d Compare May 11, 2022 21:38

zulipbot added size: L [Automatic label added by zulipbot] and removed size: XL [Automatic label added by zulipbot] labels May 11, 2022

plugyawn force-pushed the 290422 branch from b5d088d to 58f88de Compare May 11, 2022 21:41

neiljp reviewed May 13, 2022

View reviewed changes

plugyawn force-pushed the 290422 branch 9 times, most recently from e6afbdd to b89b8ab Compare June 5, 2022 02:51

plugyawn force-pushed the 290422 branch from b89b8ab to 9fc529c Compare June 5, 2022 03:00

plugyawn added PR needs review PR requires feedback to proceed and removed PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback labels Jun 5, 2022

mounilKshah reviewed Jun 8, 2022

View reviewed changes

mounilKshah added the PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback label Jun 9, 2022

neiljp removed the PR needs review PR requires feedback to proceed label Jun 19, 2022

plugyawn added 3 commits August 6, 2022 09:06

views: Add friendly times to user & message info.

90dc951

This commit implements the helper function for friendly times to the user and message info pop-ups. It shows up as Fri 4 Apr 11:05:20 PM (A week ago) And so on.

test_popups: Updated height of rendered boxes, updated tests.

62c5985

plugyawn force-pushed the 290422 branch from a112868 to 62c5985 Compare August 6, 2022 03:36

plugyawn added PR needs review PR requires feedback to proceed and removed PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback labels Aug 6, 2022

zulipbot added the has conflicts label Apr 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User-friendly date and time formatting. #1218

User-friendly date and time formatting. #1218

plugyawn commented Apr 29, 2022 •

edited

Loading

mounilKshah May 2, 2022 •

edited

Loading

neiljp commented May 4, 2022

plugyawn commented May 5, 2022 •

edited

Loading

plugyawn commented May 6, 2022

neiljp commented May 6, 2022

neiljp May 13, 2022

plugyawn May 14, 2022

plugyawn commented Jun 5, 2022

mounilKshah left a comment •

edited

Loading

mounilKshah Jun 8, 2022

mounilKshah Jun 8, 2022 •

edited

Loading

plugyawn commented Aug 6, 2022

zulipbot commented Apr 17, 2024

User-friendly date and time formatting. #1218

Are you sure you want to change the base?

User-friendly date and time formatting. #1218

Conversation

plugyawn commented Apr 29, 2022 • edited Loading

mounilKshah May 2, 2022 • edited Loading

Choose a reason for hiding this comment

neiljp commented May 4, 2022

plugyawn commented May 5, 2022 • edited Loading

plugyawn commented May 6, 2022

neiljp commented May 6, 2022

neiljp May 13, 2022

Choose a reason for hiding this comment

plugyawn May 14, 2022

Choose a reason for hiding this comment

plugyawn commented Jun 5, 2022

mounilKshah left a comment • edited Loading

Choose a reason for hiding this comment

mounilKshah Jun 8, 2022

Choose a reason for hiding this comment

mounilKshah Jun 8, 2022 • edited Loading

Choose a reason for hiding this comment

plugyawn commented Aug 6, 2022

zulipbot commented Apr 17, 2024

plugyawn commented Apr 29, 2022 •

edited

Loading

mounilKshah May 2, 2022 •

edited

Loading

plugyawn commented May 5, 2022 •

edited

Loading

mounilKshah left a comment •

edited

Loading

mounilKshah Jun 8, 2022 •

edited

Loading