fix: optimistic iou report date not matching #39665

cleverjam · 2024-04-04T23:21:18Z

Details

The "New Messages" button is incorrectly displayed when creating an IOU, caused by a date discrepancy between the report and the sorted actions and the following expression:

App/src/pages/home/report/ReportActionsList.tsx

Line 191 in 665a8ad

    
           const hasNewestReportAction = sortedReportActions?.[0].created === report.lastVisibleActionCreated;

Fixed Issues

$ #38848
PROPOSAL: #38848 (comment)

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to https://dev.new.expensify.com/
Log in
Navigate to account with a long conversation history
Send a message
Create IOU
Verify no "New Message" button shows up

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.native.mov

Android: mWeb Chrome

android.mChrome.mov

iOS: Native

ios.native.mp4

iOS: mWeb Safari

mSafari.mp4

MacOS: Chrome / Safari

desktop.chrome.mov

macos.safari.mov

MacOS: Desktop

macos.desktop.mov

…u-report-date-not-matching

…for new ious

melvin-bot · 2024-04-04T23:21:23Z

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

github-actions · 2024-04-04T23:21:29Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

cleverjam · 2024-04-04T23:38:45Z

I have read the CLA Document and I hereby sign the CLA

rushatgabhane · 2024-04-10T16:18:02Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

rushatgabhane

@cleverjam the issue is still reproducible. Please merge latest main to reproduce the issue

Screen.Recording.2024-04-11.at.05.03.06.mov

…u-report-date-not-matching

cleverjam · 2024-04-11T01:20:59Z

@rushatgabhane There is a bit of a discrepancy here:

When there is no existing money request, a new one gets created and added as the most recent report action, my change ensures that the time of this new report action matches the report.lastVisibleActionCreated as proposed in [$500] Chat – New message button appears when create IOU #38848
On the other hand, when there is an existing money request, the latest report action does not change. Instead an older action gets updated (the existing money request), in other words, the most recent action creation date will not match the report.lastVisibleActionCreated and will trigger the "New message" button.

I believe the issue scope was on IOU creation and not on IOU update, however there are several ways we can proceed here, but I need guidance.

We can chose to keep the report.lastVisibleActionCreated as is when a money request does not create a new action (because existing one gets updated). But this only work until the /api/RequestMoney response comes in and the optimistic report's value gets updated, to prevent this there needs to be a service change.
We can add even more logic in the ReportActionsList.tsx render, to match the lastVisibleActionCreated with any of the sorted report actions, if the date matches any action then set hasNewestReportAction to true preventing the button from showing, we can memo and only look if the date does not match the most recent action but this will still impact perf.

Please advise on how to proceed

rushatgabhane

@cleverjam okayy let's get this sorted. I noticed that on staging this issue doesn't occur anymore. Could you please confirm?

Screen.Recording.2024-04-15.at.19.59.27.mov

…u-report-date-not-matching

cleverjam · 2024-04-16T00:23:31Z

@rushatgabhane I can still reproduce in staging when requesting money from another user, it seems your screen capture you are requesting in a workspace...

Edit: would you like me to update render method or provide the optimistic chat report update that matches temporarily until the money request is completed?

…u-report-date-not-matching

…u is updated

cleverjam · 2024-04-17T01:04:47Z

@rushatgabhane I have updated my PR, the optimistic report's lastVisibleActionCreated still points to the most recent visible action whether the iou request is new or there is an existing IOU and the new requests gets added to that.

However, when /api/RequestMoney is resolved the lastVisibleActionCreated is updated to whatever the updated IOU created date is, that will cause the new button to show up.... I mitigated this by looking at the sorted report actions to see if any previous action matches this date. Without updates to the BE I don't think I can make this any better

rushatgabhane · 2024-04-18T16:10:40Z

@cleverjam thank you i agree

I don't have much of a clue. Let's discuss this on slack? I'll attach a link soon

…u-report-date-not-matching

cleverjam · 2024-04-25T23:30:45Z

@cleverjam thank you i agree

I don't have much of a clue. Let's discuss this on slack? I'll attach a link soon

@rushatgabhane any updates?

…u-report-date-not-matching

rushatgabhane · 2024-04-28T18:34:56Z

existing IOU and the new requests gets added to that.
However, when /api/RequestMoney is resolved the lastVisibleActionCreated is updated to whatever the updated IOU created date is, that will cause the new button to show up.... I mitigated this by looking at the sorted report actions to see if any previous action matches this date.

@cleverjam I don't think this is a good idea because the messages are paginated. We don't have all the messages on frontend.

rushatgabhane · 2024-04-28T18:37:02Z

We'll need help with backend on it.

@yuwenmemon we need your help on #39665 (comment)

yuwenmemon · 2024-04-29T18:51:24Z

@rushatgabhane what kind of back end change were you envisoning?

cleverjam · 2024-05-02T18:02:23Z

@yuwenmemon sorry about the delayed response, in essence the issue is that the report's 'lastVisibleActionCreated' does not match the most recent action in the money request response.

This occurs when a new request is added to an existing one.

Note: I am responding on GH Mobile app and can add more detail if needed once I am at my desk.

yuwenmemon · 2024-05-02T21:53:27Z

Gotcha 👍 I can take a look! Feel free to add more detail though, always welcome 😄

cleverjam · 2024-05-02T23:59:34Z

@yuwenmemon Yes! 😄

The reason why I believe the backend needs to be updated is because I was able to fix the issue (until BE update comes in) by updating the optimistic report here.

The change prevents the optimist report from merging a new lastVisibleActionCreated value when we are not creating a new request (there is an existing request which we will add the new amount into).

When testing this change we get no "New message" button during the time /api/RequestMoney is pending, and as soon as the updated report comes back from BE the message pops up.

I was able to fully test this by adding this code in the report list, basically looking in the report action list we have for the new lastVisibleActionCreated and as it turns out, that creation time is assigned to the existing money request (which is not the most recent report action)

I apologize if my assumption is incorrect here, perhaps there are other things I can do in the FE to fix the issue? this is my first contribution to this project and I am still learning its ways.

…u-report-date-not-matching

cleverjam · 2024-06-07T00:01:20Z

@yuwenmemon did you get a chance to look into this?

yuwenmemon · 2024-06-07T04:07:25Z

Ah jeez, sorry I did not! Assigned myself so I don't forget about this.

cleverjam · 2024-06-07T21:22:41Z

no problem, just checking, let me know if any of this doesn't make sense or needs to be reconsidered in the FE, thanks!

yuwenmemon · 2024-08-14T20:39:02Z

Closing as per: #38848 (comment)

cleverjam added 4 commits April 3, 2024 19:00

test: add a failing test

bd1c53d

refactor: use original time in optimistic iou report creation

3dc5330

Merge remote-tracking branch 'upstream/main' into 38848-optimistic-io…

59e55c2

…u-report-date-not-matching

feat: update optimistic iou report date and only update last visible …

ed24e3b

…for new ious

cleverjam requested a review from a team as a code owner April 4, 2024 23:21

melvin-bot bot requested review from rushatgabhane and removed request for a team April 4, 2024 23:21

rushatgabhane suggested changes Apr 10, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into 38848-optimistic-io…

d135b2f

…u-report-date-not-matching

rushatgabhane suggested changes Apr 15, 2024

View reviewed changes

cleverjam added 2 commits April 15, 2024 18:46

Merge remote-tracking branch 'upstream/main' into 38848-optimistic-io…

7069e42

…u-report-date-not-matching

fix: avoid setting iouCreationTime to empty str

e9c2e1a

cleverjam added 3 commits April 16, 2024 18:16

Merge remote-tracking branch 'upstream/main' into 38848-optimistic-io…

857549e

…u-report-date-not-matching

fix: chat report last visible action should not change when an old io…

e40dd6e

…u is updated

fix: sometimes the last visible action is part of an old thread

f05942d

Merge remote-tracking branch 'upstream/main' into 38848-optimistic-io…

4ed0fc7

…u-report-date-not-matching

Merge remote-tracking branch 'upstream/main' into 38848-optimistic-io…

9071976

…u-report-date-not-matching

cleverjam mentioned this pull request Apr 29, 2024

[$500] Chat – New message button appears when create IOU #38848

Closed

6 tasks

Merge remote-tracking branch 'upstream/main' into 38848-optimistic-io…

6a38973

…u-report-date-not-matching

tsa321 mentioned this pull request May 21, 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

yuwenmemon self-requested a review June 7, 2024 04:07

yuwenmemon closed this Aug 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: optimistic iou report date not matching #39665

fix: optimistic iou report date not matching #39665

cleverjam commented Apr 4, 2024 •

edited

Loading

melvin-bot bot commented Apr 4, 2024

github-actions bot commented Apr 4, 2024 •

edited

Loading

cleverjam commented Apr 4, 2024

rushatgabhane commented Apr 10, 2024

rushatgabhane left a comment •

edited

Loading

cleverjam commented Apr 11, 2024

rushatgabhane left a comment •

edited

Loading

cleverjam commented Apr 16, 2024 •

edited

Loading

cleverjam commented Apr 17, 2024

rushatgabhane commented Apr 18, 2024 •

edited

Loading

cleverjam commented Apr 25, 2024

rushatgabhane commented Apr 28, 2024

rushatgabhane commented Apr 28, 2024

yuwenmemon commented Apr 29, 2024

cleverjam commented May 2, 2024

yuwenmemon commented May 2, 2024

cleverjam commented May 2, 2024

cleverjam commented Jun 7, 2024

yuwenmemon commented Jun 7, 2024

cleverjam commented Jun 7, 2024

yuwenmemon commented Aug 14, 2024

fix: optimistic iou report date not matching #39665

fix: optimistic iou report date not matching #39665

Conversation

cleverjam commented Apr 4, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 4, 2024

github-actions bot commented Apr 4, 2024 • edited Loading

cleverjam commented Apr 4, 2024

rushatgabhane commented Apr 10, 2024

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

cleverjam commented Apr 11, 2024

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

cleverjam commented Apr 16, 2024 • edited Loading

cleverjam commented Apr 17, 2024

rushatgabhane commented Apr 18, 2024 • edited Loading

cleverjam commented Apr 25, 2024

rushatgabhane commented Apr 28, 2024

rushatgabhane commented Apr 28, 2024

yuwenmemon commented Apr 29, 2024

cleverjam commented May 2, 2024

yuwenmemon commented May 2, 2024

cleverjam commented May 2, 2024

cleverjam commented Jun 7, 2024

yuwenmemon commented Jun 7, 2024

cleverjam commented Jun 7, 2024

yuwenmemon commented Aug 14, 2024

cleverjam commented Apr 4, 2024 •

edited

Loading

github-actions bot commented Apr 4, 2024 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

rushatgabhane left a comment •

edited

Loading

cleverjam commented Apr 16, 2024 •

edited

Loading

rushatgabhane commented Apr 18, 2024 •

edited

Loading