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

fix: jumpToMessage flashing the bottom of new chat #4562

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

WofWca
Copy link
Collaborator

@WofWca WofWca commented Jan 25, 2025

This is based on #4561 and #4554. This MR is about just the last commit.

Before:

2025-01-25-dJg0vlnERM.mp4

After:

2025-01-25-3MvuK7WRE8.mp4

That is, when you jump to a message in a different chat
(e.g. by clicking on a notification, or from message search,
or from a "private reply" quote),
we would momentarily show the new chat scrolled to bottom
prior to jumping to the desired message.

Why this is bad:

  • We mark the visible messages as read.
    In this case that would be the last messages in the chat.
    But they weren't actually read, the user did not intend
    to scroll to them.
  • Extra layout shifting: not great visually.
  • Bad for performance. Let's just load the part of the chat
    that we need right away.

Related:

Copy link
Member

@nicodh nicodh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed by testing

That is, when you jump to a message in a different chat
(e.g. by clicking on a notification, or from message search,
or from a "private reply" quote),
we would momentarily show the new chat scrolled to bottom
prior to jumping to the desired message.

Why this is bad:

- We mark the visible messages as read.
  In this case that would be the last messages in the chat.
  But they weren't actually read, the user did not intend
  to scroll to them.
- Extra layout shifting: not great visually.
- Bad for performance. Let's just load the part of the chat
  that we need right away.

Related:
- #4508
- #4510
- #4554
@WofWca WofWca force-pushed the wofwca/fix-momentary-jump-to-bottom branch from fb94da3 to 7aafc25 Compare January 31, 2025 10:20
@WofWca WofWca merged commit 637497c into main Jan 31, 2025
9 of 10 checks passed
@WofWca WofWca deleted the wofwca/fix-momentary-jump-to-bottom branch January 31, 2025 10:21
WofWca added a commit that referenced this pull request Feb 15, 2025
To reproduce, simply double click on a chat in the chat list
really fast.
Or:

```javascript
item = document.querySelector(
  '.chat-list-item:not(.archive-link-item):not(.selected)'
);
chatListItem.click();
// Let React re-render, then click again.
setTimeout(() => chatListItem.click());
```

The problem is, in `selectChat` we have code that is supposed to
jump to the last message when the currently selected chat
gets clicked again.
However, if the chat has not loaded yet, and thus a new instance
of `MessageListStore` has not been created yet, and thus its
`loadChat()` has not been called yet,
then, when `loadChat()` does get called eventually,
it will see that `__internal_jump_to_message_asap` is set,
and so it will call `__jumpToMessage`, with `msgId: undefined`.
But, it turns out, `__jumpToMessage` cannot handle this case.
It would try to look up the last message in
`this.state.messageListItems`, but it is empty
(see the `items.length <= 0` line), so `__jumpToMessage()`
would simply return and do nothing, resulting in an empty chat.
But `messageListItems` is empty not because
there are really no messages in the chat,
but because `MessageListStore` has not loaded anything yet,
because, as you remember, `loadChat()` delegated its responsibility
to `__jumpToMessage()`.

This commit ensures that `__jumpToMessage()` handles the case where
`MessageListStore` has not loaded anything yet,
and where `msgId === undefined`.

It appears that the reproduction steps above is the only way
this bug can occur, because it's pretty much the only way
to have `msgId: undefined` (except for the "jump down" button).
So this commit probably doesn't fix any other current bugs.

The issue that this commit fixes was likely introduced in
#4562
(637497c).
WofWca added a commit that referenced this pull request Feb 15, 2025
To reproduce, simply double click on a chat in the chat list
really fast.
Or:

```javascript
item = document.querySelector(
  '.chat-list-item:not(.archive-link-item):not(.selected)'
);
chatListItem.click();
// Let React re-render, then click again.
setTimeout(() => chatListItem.click());
```

The problem is, in `selectChat` we have code that is supposed to
jump to the last message when the currently selected chat
gets clicked again.
However, if the chat has not loaded yet, and thus a new instance
of `MessageListStore` has not been created yet, and thus its
`loadChat()` has not been called yet,
then, when `loadChat()` does get called eventually,
it will see that `__internal_jump_to_message_asap` is set,
and so it will call `__jumpToMessage`, with `msgId: undefined`.
But, it turns out, `__jumpToMessage` cannot handle this case.
It would try to look up the last message in
`this.state.messageListItems`, but it is empty
(see the `items.length <= 0` line), so `__jumpToMessage()`
would simply return and do nothing, resulting in an empty chat.
But `messageListItems` is empty not because
there are really no messages in the chat,
but because `MessageListStore` has not loaded anything yet,
because, as you remember, `loadChat()` delegated its responsibility
to `__jumpToMessage()`.

This commit ensures that `__jumpToMessage()` handles the case where
`MessageListStore` has not loaded anything yet,
and where `msgId === undefined`.

It appears that the reproduction steps above is the only way
this bug can occur, because it's pretty much the only way
to have `msgId: undefined` (except for the "jump down" button).
So this commit probably doesn't fix any other current bugs.

The issue that this commit fixes was likely introduced in
#4562
(637497c).
WofWca added a commit that referenced this pull request Feb 18, 2025
To reproduce, simply double click on a chat in the chat list
really fast.
Or:

```javascript
item = document.querySelector(
  '.chat-list-item:not(.archive-link-item):not(.selected)'
);
chatListItem.click();
// Let React re-render, then click again.
setTimeout(() => chatListItem.click());
```

The problem is, in `selectChat` we have code that is supposed to
jump to the last message when the currently selected chat
gets clicked again.
However, if the chat has not loaded yet, and thus a new instance
of `MessageListStore` has not been created yet, and thus its
`loadChat()` has not been called yet,
then, when `loadChat()` does get called eventually,
it will see that `__internal_jump_to_message_asap` is set,
and so it will call `__jumpToMessage`, with `msgId: undefined`.
But, it turns out, `__jumpToMessage` cannot handle this case.
It would try to look up the last message in
`this.state.messageListItems`, but it is empty
(see the `items.length <= 0` line), so `__jumpToMessage()`
would simply return and do nothing, resulting in an empty chat.
But `messageListItems` is empty not because
there are really no messages in the chat,
but because `MessageListStore` has not loaded anything yet,
because, as you remember, `loadChat()` delegated its responsibility
to `__jumpToMessage()`.

This commit ensures that `__jumpToMessage()` handles the case where
`MessageListStore` has not loaded anything yet,
and where `msgId === undefined`.

It appears that the reproduction steps above is the only way
this bug can occur, because it's pretty much the only way
to have `msgId: undefined` (except for the "jump down" button).
So this commit probably doesn't fix any other current bugs.

The issue that this commit fixes was likely introduced in
#4562
(637497c).
WofWca added a commit that referenced this pull request Feb 18, 2025
To reproduce, simply double click on a chat in the chat list
really fast.
Or:

```javascript
item = document.querySelector(
  '.chat-list-item:not(.archive-link-item):not(.selected)'
);
chatListItem.click();
// Let React re-render, then click again.
setTimeout(() => chatListItem.click());
```

The problem is, in `selectChat` we have code that is supposed to
jump to the last message when the currently selected chat
gets clicked again.
However, if the chat has not loaded yet, and thus a new instance
of `MessageListStore` has not been created yet, and thus its
`loadChat()` has not been called yet,
then, when `loadChat()` does get called eventually,
it will see that `__internal_jump_to_message_asap` is set,
and so it will call `__jumpToMessage`, with `msgId: undefined`.
But, it turns out, `__jumpToMessage` cannot handle this case.
It would try to look up the last message in
`this.state.messageListItems`, but it is empty
(see the `items.length <= 0` line), so `__jumpToMessage()`
would simply return and do nothing, resulting in an empty chat.
But `messageListItems` is empty not because
there are really no messages in the chat,
but because `MessageListStore` has not loaded anything yet,
because, as you remember, `loadChat()` delegated its responsibility
to `__jumpToMessage()`.

This commit ensures that `__jumpToMessage()` handles the case where
`MessageListStore` has not loaded anything yet,
and where `msgId === undefined`.

It appears that the reproduction steps above is the only way
this bug can occur, because it's pretty much the only way
to have `msgId: undefined` (except for the "jump down" button).
So this commit probably doesn't fix any other current bugs.

The issue that this commit fixes was likely introduced in
#4562
(637497c).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants