Skip to content
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.

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

Search results should show recipient headers for every message #1550

Open
neiljp opened this issue Oct 5, 2024 · 4 comments · May be fixed by #1552
Open

Search results should show recipient headers for every message #1550

neiljp opened this issue Oct 5, 2024 · 4 comments · May be fixed by #1552
Assignees
Labels
area: message rendering area: message search bug Something isn't working help wanted This issue should be clear enough to work on high priority should be done as soon as possible in progress

Comments

@neiljp
Copy link
Collaborator

neiljp commented Oct 5, 2024

Bug description

When searching (for text, our only option right now), it is possible to end up with results that show messages adjacently under the same heading (recipients, conversation).

This can be confusing, since these messages may be in the same conversation, but there may be messages between them that do not meet the search criteria (filter text), and it appears that the messages simply follow one another.

This was partially inspired by # design > Date indicators in search results.

How is the bug triggered?

How can you reproduce the bug?

Currently:

  1. Go to All messages view in ZT
  2. Search for the text (eg. /, 'date indicators', Enter)
  3. (Possibly scroll up/down to look for examples)
  4. Observe multiple conversations with adjacent messages under the same header line

Repeating in the web app shows each message with its own equivalent of our header line

A few examples with this search text are:

  • # api design > trimming date_joined (two messages on 27 & 31 July 2024, separated by others)
  • # design > Date indicators in search results (two time-adjacent messages)

What did you expect to happen?

In the web client, this appears to be resolved by showing the recipient (conversation) header for every message in a search result.

While extra lines are at a premium in a terminal, we should show extra header lines a similar way, ie. showing the message recipient line above each message.

Note that it should not display the recipient part of the header in conversation views (specific DMs, topics), just like now, since the header information is in the part above that already.

We should also ensure the message line with the status/author/date, particularly the date, should always be shown - that is the default with the current code, except for two messages written to the same conversation within a narrow time window by the same sender. We should ensure the date appears in every message, when such messages are split by a recipient header, once this feature is implemented.

How are you running the application?

Please include as many of the following as possible:

  • Zulip-terminal version: main in September 2024
  • Zulip server version(s): chat.zulip.org
  • Operating system (and version): Debian
  • Python version (and implementation): CPython 3.9

Related future follow-ups

  • To save space, we might be able to 'fold' conversations where eg. the search text is in a topic name. That would avoid showing every matching message, along with the title bar for each.
  • Highlighting search terms in search results.
@neiljp neiljp added bug Something isn't working help wanted This issue should be clear enough to work on high priority should be done as soon as possible area: message rendering area: message search labels Oct 5, 2024
@neoandmatrix
Copy link
Collaborator

@zulipbot claim

@zulipbot
Copy link
Member

zulipbot commented Oct 5, 2024

Welcome to Zulip, @neoandmatrix! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip-terminal/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

@u7327620
Copy link
Collaborator

@zulipbot claim

@zulipbot
Copy link
Member

Welcome to Zulip, @u7327620! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip-terminal/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 20, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes part of zulip#1550.
u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 23, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes part of zulip#1550.
u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 23, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes part of zulip#1550.
u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 24, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes part of zulip#1550.
u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 24, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes part of zulip#1550.
u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 24, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes part of zulip#1550.
u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 24, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes part of zulip#1550.
u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 24, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes part of zulip#1550.
u7327620 added a commit to u7327620/text-search-message-headers that referenced this issue Oct 24, 2024
Previously, when text searching, messages appear
adjacently under the same heading, this can be confusing since they
appear sequentially but there may be messages inbetween that don't meet
the search criteria. Fixes zulip#1550.
@u7327620 u7327620 linked a pull request Oct 24, 2024 that will close this issue
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: message rendering area: message search bug Something isn't working help wanted This issue should be clear enough to work on high priority should be done as soon as possible in progress
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants