fix: expense chat doesn't scroll to bottom when we create a distance request #39685

nkdengineer · 2024-04-05T08:17:42Z

Details

Fixed Issues

$ #39198
PROPOSAL: #39198 (comment)

Tests

Go to WS chat
Create money request
Go to expense report
Add new message or create money request
Verify that: the expense chat is scroll to bottom

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Go to WS chat
Create money request
Go to expense report
Add new message or create money request
Verify that: the expense chat is scroll to 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

android-resize.mp4

Android: mWeb Chrome

android-mweb-resize.mp4

iOS: Native

ios-resize.mp4

iOS: mWeb Safari

ios-mweb-resize.mp4

MacOS: Chrome / Safari

web-resize.mp4

MacOS: Desktop

desktop-resize.mp4

…request

melvin-bot · 2024-04-05T09:56:22Z

@dukenv0307 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]

dukenv0307 · 2024-04-08T07:03:35Z

src/libs/actions/IOU.ts

@@ -1391,7 +1391,8 @@ function createDistanceRequest(

    API.write(WRITE_COMMANDS.CREATE_DISTANCE_REQUEST, parameters, onyxData);
    Navigation.dismissModal(isMoneyRequestReport ? report.reportID : chatReport.reportID);
-    Report.notifyNewAction(chatReport.reportID, userAccountID);
+    const activeReportID = isMoneyRequestReport ? report.reportID : chatReport.reportID;


move that line at the beginning and use it to prevent duplicated code

src/pages/home/report/ReportActionsList.tsx

dukenv0307 · 2024-04-08T07:08:31Z

@nkdengineer Can you update Offline tests?. If the steps are similar to the tests step above we can simply add Same as bove

nkdengineer · 2024-04-08T07:46:49Z

@dukenv0307 I updated your suggestions.

dukenv0307 · 2024-04-08T08:36:53Z

Code looks good, will start to record videos in a hour

dukenv0307 · 2024-04-08T08:37:00Z

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 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

web-resize.mp4

Android: mWeb Chrome

web-resize.mp4

iOS: Native

web-resize.mp4

iOS: mWeb Safari

web-resize.mp4

MacOS: Chrome / Safari

web-resize.mp4

MacOS: Desktop

web-resize.mp4

dukenv0307 · 2024-04-08T09:07:36Z

Tests well

aldo-expensify

I think the ref value should be updated outside

nkdengineer · 2024-04-09T04:15:12Z

src/pages/home/report/ReportActionsList.tsx

@@ -226,6 +226,7 @@ function ReportActionsList({
        }
        previousLastIndex.current = lastActionIndex;
        reportActionSize.current = sortedVisibleReportActions.length;
+        hasNewestReportActionRef.current = hasNewestReportAction;


@aldo-expensify We update hasNewestReportActionRef whenever hasNewestReportAction is changed in this useEffect so I think it will not out of sync, as you see we also update other ref like previousLastIndex, reportActionSize in this useEffect.

They are updated in different parts of the lifecycle:

hasNewestReportAction changes during rendering

hasNewestReportActionRef changes when evaluating useEffects

I'm not familiar enough with the react architecture to be sure that scrollToBottomForCurrentUserAction will never be called in between rendering and useEffects when listening to a "new action event" (I haven't looked at the implementation in Report.subscribeToNewActionEvent).

Are you 100% that javascript won't process any other js code (including event listeners) between those two parts of the react lifecycle (rendering/side effects)?

Even if you are sure of the above, I still find it more messy to update this ref here if it is supposed to be in sync with the hasNewestReportAction.

@aldo-expensify @nkdengineer scrollToBottomForCurrentUserAction can be called in between rendering and useEffects. But, the synchronization time between ref and hasNewestReportAction is too small, and hasNewestReportAction is not changed frequently. Besides, we're updating the ref in useEffect most places in our App, so I think it's ok.

I just don't want to update the ref every time the page re-renders and make codes consistency. Wdyt?

I agree with that the window is small, but why take the risk?

Besides, we're updating the ref in useEffect most places in our App, so I think it's ok.

It may be a bad pattern? 🤷

I just don't want to update the ref every time the page re-renders and make codes consistency. Wdyt?

What is the problem of updating during rendering? I'm sure there is not performance issue, and for me it is more visible to update it next to where you defined and initialized the variable you are copying. Putting it a useEffect makes the code less readable IMO. There may be reasons to do it in other places, but I don't see one here.

@nkdengineer Alright, that makes sense to me now, can you update the PR based on @aldo-expensify's suggestion above?

Thanks, that also makes sense to me now.

@aldo-expensify @dukenv0307 I updated to update the ref whenever re-rendering.

Thank you both

@nkdengineer @dukenv0307 It looks like the refactor has caused a regression here.
I am not sure if I understand why this refactor was needed to fix this issue.
Can you please help me understand this?

OSBotify · 2024-04-12T17:23:33Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-04-18T04:56:29Z

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T14:57:28Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

nkdengineer added 2 commits April 5, 2024 14:55

fix: expense chat doesn't scroll to bottom when we create a distance …

8d82be1

…request

fix lint

1636ef6

nkdengineer marked this pull request as ready for review April 5, 2024 09:56

nkdengineer requested a review from a team as a code owner April 5, 2024 09:56

melvin-bot bot requested review from dukenv0307 and removed request for a team April 5, 2024 09:56

nkdengineer mentioned this pull request Apr 5, 2024

[$500] The expense chat doesn't scroll to bottom when we create a distance request #39198

Closed

6 tasks

dukenv0307 reviewed Apr 8, 2024

View reviewed changes

src/pages/home/report/ReportActionsList.tsx Show resolved Hide resolved

nkdengineer added 2 commits April 8, 2024 14:40

Merge branch 'main' into fix/39198

503e821

refactor logic

d16be16

remove unnecessary useEffect

4651dd8

dukenv0307 approved these changes Apr 8, 2024

View reviewed changes

melvin-bot bot requested a review from aldo-expensify April 8, 2024 09:07

aldo-expensify requested changes Apr 8, 2024

View reviewed changes

gijoe0295 mentioned this pull request Apr 9, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807

Closed

nkdengineer commented Apr 9, 2024

View reviewed changes

nkdengineer mentioned this pull request Apr 11, 2024

[HOLD for #39198] Chat - Chat does not scroll to the latest messages when new message sent #40094

Closed

6 tasks

nkdengineer added 2 commits April 12, 2024 10:42

merge main

d0d0049

update ref whenever rendering

e615d8e

aldo-expensify approved these changes Apr 12, 2024

View reviewed changes

aldo-expensify merged commit e8c57de into Expensify:main Apr 12, 2024
17 checks passed

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

lanitochka17 mentioned this pull request Apr 19, 2024

[HOLD #40724] [$250] IOU –Expense chat doesn't scroll to bottom when send message and create second money request #40594

Closed

6 tasks

rojiphil mentioned this pull request May 25, 2024

[HOLD for payment 2024-06-20] [HOLD for payment 2024-06-18] CRITICAL: [UX Reliability] [$1000] Chat - Chat does not scroll down when sending messages #40724

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: expense chat doesn't scroll to bottom when we create a distance request #39685

fix: expense chat doesn't scroll to bottom when we create a distance request #39685

nkdengineer commented Apr 5, 2024 •

edited

Loading

melvin-bot bot commented Apr 5, 2024

dukenv0307 Apr 8, 2024

dukenv0307 commented Apr 8, 2024

nkdengineer commented Apr 8, 2024

dukenv0307 commented Apr 8, 2024

dukenv0307 commented Apr 8, 2024 •

edited

Loading

dukenv0307 commented Apr 8, 2024

aldo-expensify left a comment

nkdengineer Apr 9, 2024

aldo-expensify Apr 9, 2024

dukenv0307 Apr 11, 2024

aldo-expensify Apr 11, 2024

dukenv0307 Apr 12, 2024

nkdengineer Apr 12, 2024

nkdengineer Apr 12, 2024

aldo-expensify Apr 12, 2024

rojiphil May 25, 2024

OSBotify commented Apr 12, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 22, 2024

fix: expense chat doesn't scroll to bottom when we create a distance request #39685

fix: expense chat doesn't scroll to bottom when we create a distance request #39685

Conversation

nkdengineer commented Apr 5, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 5, 2024

Choose a reason for hiding this comment

dukenv0307 commented Apr 8, 2024

nkdengineer commented Apr 8, 2024

dukenv0307 commented Apr 8, 2024

dukenv0307 commented Apr 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

dukenv0307 commented Apr 8, 2024

aldo-expensify left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Apr 12, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 22, 2024

nkdengineer commented Apr 5, 2024 •

edited

Loading

dukenv0307 commented Apr 8, 2024 •

edited

Loading