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 chat doesn't scroll to bottom #43021

Merged
merged 11 commits into from
Jun 10, 2024
Merged

Conversation

nkdengineer
Copy link
Contributor

Details

Fix chat doesn't scroll to bottom

Fixed Issues

$ #40724
PROPOSAL: #40724 (comment)

Tests

  • For attachments, text messages, For whispers.
  1. Open a DM chat or WS chat that has long history chat
  2. Send an attachments
  3. Verify that the chat scrolls to the bottom
  4. Scroll to the top and send a message
  5. Verify that the chat scrolls to the bottom
  6. Create a split expense
  7. Verify that the chat scrolls to the bottom
  • For IOU reports, For IOU previews.
  1. Open a IOU report
  2. Send a message
  3. Verify that the chat scrolls to the bottom
  4. Submit an expense
  5. Verify that the chat scrolls to the bottom
  • For thread replies
  1. Open a thread with long history chat
  2. Scroll to the top and send a message
  3. Verify that the chat scrolls to the bottom
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  • For attachments, text messages, For whispers.
  1. Open a DM chat or WS chat that has long history chat
  2. Send an attachments
  3. Verify that the chat scrolls to the bottom
  4. Scroll to the top and send a message
  5. Verify that the chat scrolls to the bottom
  6. Create a split expense
  7. Verify that the chat scrolls to the bottom
  • For IOU reports, For IOU previews.
  1. Open a IOU report
  2. Send a message
  3. Verify that the chat scrolls to the bottom
  4. Submit an expense
  5. Verify that the chat scrolls to the bottom
  • For thread replies
  1. Open a thread with long history chat
  2. Scroll to the top and send a message
  3. Verify that the chat scrolls to the bottom
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
  • For attachments, text messages, For whispers.
Screen.Recording.2024-06-04.at.12.46.52.mov
  • For IOU reports, For IOU previews.
Screen.Recording.2024-06-04.at.12.50.19.mov
  • For thread replies
Screen.Recording.2024-06-04.at.12.50.56.mov
Android: mWeb Chrome
  • For attachments, text messages, For whispers.
Screen.Recording.2024-06-04.at.12.44.33.mov
  • For IOU reports, For IOU previews.
Screen.Recording.2024-06-04.at.12.45.37.mov
  • For thread replies
Screen.Recording.2024-06-04.at.12.46.13.mov
iOS: Native
  • For attachments, text messages, For whispers.
ios-1-1.mov
  • For IOU reports, For IOU previews.
Screen.Recording.2024-06-03.at.13.11.07.mov
  • For thread replies
Screen.Recording.2024-06-03.at.13.11.52.mov
iOS: mWeb Safari
  • For attachments, text messages, For whispers.
safari-1.mov
  • For IOU reports, For IOU previews.
Screen.Recording.2024-06-04.at.12.37.45.mov
  • For thread replies
Screen.Recording.2024-06-04.at.12.40.19.mov
MacOS: Chrome / Safari
  • For attachments, text messages, For whispers.
case1-1.mov
  • For IOU reports, For IOU previews.
Screen.Recording.2024-06-03.at.10.59.00.mov
  • For thread replies
Screen.Recording.2024-06-03.at.10.59.16.mov
MacOS: Desktop
  • For attachments, text messages, For whispers.
desktop-1.mov
  • For IOU reports, For IOU previews.
Screen.Recording.2024-06-04.at.12.55.12.mov
  • For thread replies
Screen.Recording.2024-06-04.at.12.55.30.mov

@nkdengineer nkdengineer marked this pull request as ready for review June 4, 2024 06:10
@nkdengineer nkdengineer requested a review from a team as a code owner June 4, 2024 06:10
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team June 4, 2024 06:10
Copy link

melvin-bot bot commented Jun 4, 2024

@parasharrajat Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@parasharrajat
Copy link
Member

Testing...

@mountiny
Copy link
Contributor

mountiny commented Jun 4, 2024

Running a build

@parasharrajat
Copy link
Member

Looks like we will reintroduce #41188

Copy link
Contributor

github-actions bot commented Jun 4, 2024

@mountiny
Copy link
Contributor

mountiny commented Jun 4, 2024

@parasharrajat what is your ETA on this one? I think this on eis one of the most important PRs to get out now in App

@parasharrajat
Copy link
Member

parasharrajat commented Jun 4, 2024

I posted one issue above. I am testing other parts too.

src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
@@ -210,12 +210,9 @@ function ReportActionsList({
[sortedReportActions, isOffline],
);

// whisper action doesn't affect lastVisibleActionCreated, so we should not take it into account while checking if there is the newest report action
const newestVisibleReportAction = useMemo(() => sortedVisibleReportActions.find((item) => !ReportActionsUtils.isWhisperAction(item)) ?? null, [sortedVisibleReportActions]);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks like we will reintroduce #41188

@parasharrajat

I believe it's a back-end bug. After we start s split bill, BE doesn't return the updated lastVisibleActionCreated of the report but when OpenReport API is called, we can see the lastVisibleActionCreated is returned as the created of split whisper action above.

Screenshot 2024-06-05 at 15 03 54

So I removed this change from this PR. If not when we reload this report and send any action like message, expense, ... the chat will not scroll to the bottom

Copy link
Member

Choose a reason for hiding this comment

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

@mountiny Do you know why it is different on backend? The comment says that whisper does not affect the lastVisibleActionCreated time.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this for the same account that created the split bill request? If so, we should use the whisper created, no?

Copy link
Contributor

Choose a reason for hiding this comment

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

Commented in Slack

Copy link
Contributor

Choose a reason for hiding this comment

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

Following along because I'm the BZ team member on #41188. Do you all feel that a regression was introduced in that issue? It's due to be paid out, but I will hold on that if there's a regression.

Copy link
Member

Choose a reason for hiding this comment

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

There was no regression as such.

Copy link
Contributor

Choose a reason for hiding this comment

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

Awesome. Thanks, @parasharrajat!

@parasharrajat
Copy link
Member

parasharrajat commented Jun 5, 2024

Continue testing...

Yesterday, I was looking into the various functions that create actions for reports but I saw a few of them does not update lastVisibleActionCreated for parent report. Reason is not very clear to me. I am going to test each type of action one by one and observe the results.

@parasharrajat
Copy link
Member

parasharrajat commented Jun 5, 2024

@nkdengineer

Let's dicsuss one case for getSendInvoiceInformation

How the time will match for both the report and last action? Both functions are using same DateUtils.getDBTime function like the one in addActions.

And if this is working fine, why doesn't it work for addActions too?

const optimisticInvoiceReport = ReportUtils.buildOptimisticInvoiceReport(chatReport.reportID, senderWorkspaceID, receiverAccountID, receiver.displayName ?? '', amount, currency);

ReportUtils.buildOptimisticMoneyRequestEntities(

@nkdengineer
Copy link
Contributor Author

Let's dicsuss one case for getSendInvoiceInformation

@parasharrajat

Currently, we still have the different at two place we call DateUtils.getDBTime() let see this image below for more detail.
But the different time is too small or usually no different so when we convert this to iso string, it's equal.

Screenshot 2024-06-05 at 20 54 39

Checked again with addActions and I saw the current RCA. We call DateUtils.getDBTimeWithSkew which doesn't work as expected

const currentTime = DateUtils.getDBTimeWithSkew();

Let see here, when we call getDBTimeWithSkew() without any param, the timestamp now is empty that make new Date(timestamp).valueOf() is NaN and then getDBTime(NaN) will return the current time without networkTimeSkew

return getDBTime(new Date(timestamp).valueOf() + networkTimeSkew);

Meanwhile here we call getDBTimeWithSkew with the timestamp is the current time (createdOffset is 0 in this case) and then it will return the time with additional networkTimeSkew

created: DateUtils.getDBTimeWithSkew(Date.now() + createdOffset),

That is the reason why for addActions case, lastVisibleActionCreated is always less than created of last action.

The solution here is we should update getDBTimeWithSkew to make it work as expected like this

function getDBTimeWithSkew(timestamp: string | number = ''): string {
    if (networkTimeSkew > 0) {
        const datetime = timestamp ? new Date(timestamp) : new Date();
        return getDBTime(datetime.valueOf() + networkTimeSkew);
    }
    return getDBTime(timestamp);
}

@parasharrajat
Copy link
Member

So why's aren't we changing this instead of current solution on the PR?

@nkdengineer
Copy link
Contributor Author

So why's aren't we changing this instead of current solution on the PR?

@parasharrajat

  1. I didn't check about getDBTimeWithSkew before. Updated it now.

  2. The current solution can make sure that lastVisibleActionCreate and created are always the same. We can't make sure that call DateUtils.getDBTime at two place can return the same result because if the first place has complex logic, it can have some delay when we call DateUtils.getDBTime. For example, for the case when we create request money, if we get DateUtils.getDBTime in buildOnyxDataForMoneyRequest the time will be different from iouAction.created

@nkdengineer
Copy link
Contributor Author

@parasharrajat I updated to fix two cases above.

ios/Podfile.lock Outdated Show resolved Hide resolved
@parasharrajat
Copy link
Member

parasharrajat commented Jun 6, 2024

Screenshots

🔲 iOS / native

08.06.2024_00.43.31_REC.mp4

🔲 iOS / Safari

08.06.2024_02.23.05_REC.mp4

🔲 MacOS / Desktop

08.06.2024_01.49.32_REC.mp4

🔲 MacOS / Chrome

hm.mp4
07.06.2024_02.26.16_REC.mp4

🔲 Android / Chrome

08.06.2024_02.12.16_REC.mp4

🔲 Android / native

07.06.2024_23.29.46_REC.mp4
07.06.2024_23.32.28_REC.mp4
07.06.2024_23.39.39_REC.mp4

@parasharrajat
Copy link
Member

So currently, I am facing chat loading issues. I am still trying to test other cases as much as possible.

Pending tests:

  1. New line indicator tests.
  2. LHN chat order.

@parasharrajat
Copy link
Member

@mountiny @luacmartins I noticed that the chat scrolls to bottom first and then the new message is created/shown to the user. Do you think it is correct behaviour? Or is it supposed to happen together? Or when chat is scrolled to bottom the message should already be there.

can we move forward this behaviour on this PR?

07.06.2024_23.32.28_REC.mp4

@luacmartins
Copy link
Contributor

Hmm I'd say that ideally it scrolls at the same time we create the action, but I'm not sure this should be a blocker here since the current behavior (not scrolling) is worse

@parasharrajat
Copy link
Member

Testing new line indicator...

@parasharrajat
Copy link
Member

BUG: Android:IOS: New line marker hides immediately when opening a unread chat.

Steps:

  1. Open the app.
  2. Got to LHN.
  3. Send a message from USER A to USER B.
  4. Open the chat with User B on device 2.
  5. Observe that the new marker hides immediately.

@parasharrajat
Copy link
Member

BUG: Android: ioS: The new message button does not show until chat is scrolled.

Steps:

  1. Open a chat between user a and user B.
  2. Scroll in the chat history.
  3. Send msg from B to A.
  4. Observe that new message button does not show until we scroll the chat a bit.

@parasharrajat
Copy link
Member

parasharrajat commented Jun 7, 2024

Sometimes, the chat does not scroll to the bottom. It only happens once and then for all messages chat scrolls fine. I noticed this on multiple platforms.

Here is the vid. Check the message at 0:12 sec. I believe this might have a different root cause.

Untitled.mp4

@parasharrajat
Copy link
Member

OK, so both of these bugs are present on main #43021 (comment) & #43021 (comment).

Which means new line marker is broken ATM. cc @luacmartins

@parasharrajat
Copy link
Member

The rest looks pretty good. Can we proceed with the above issues? @luacmartins

@mountiny
Copy link
Contributor

mountiny commented Jun 8, 2024

@parasharrajat so you were not able to find any issues that are not repro in main as well?

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Changes look good to me and if all the bugs you were able to find also exist in main, I think we can proceed and hope there wont be anything bad

@parasharrajat
Copy link
Member

@nkdengineer What do you think about #43021 (comment) & #43021 (comment) & #43021 (comment)

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from mountiny June 9, 2024 09:18
@parasharrajat
Copy link
Member

I think we can move forward with the PR. It solves the main issue.

@nkdengineer
Copy link
Contributor Author

@nkdengineer What do you think about #43021 (comment) & #43021 (comment) & #43021 (comment)

I think we can move forward with this PR since these bugs also happen on main.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

deploy checklist is not locked yet, I will merge this so we can get it to staging now

@mountiny mountiny merged commit feba10e into Expensify:main Jun 10, 2024
15 checks passed
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.81-1 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Thanks for working on this!

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants