Update optimistic data to match IOU action notification templates, send back additional data needed by Settle Up templates

[jasperhuangg]

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/270495

Tests/QA

Once the server responds, the report action may change. This will be fixed in https://github.com/Expensify/Web-Expensify/pull/36977

Request Money

1. As userA, FAB > Request Money to userB. Be sure to include a note for what the request is for, like Thursday lunch.
2. Verify that userB receives a report action like Requested $20 for Thursday lunch.

Split bill

1. As userA, FAB > Split Bill to multiple users. Be sure to include a note for what the split is for, like Thursday lunch.
2. Verify that all users that were included in the split receive a report action like Requested $20 for Thursday lunch.

Settling up

1. Settle up any of the above requests.
2. Verify that a report action is received like Settled up $20.

Requesting Money/Settling Up in a non-US currency

1. As userA, FAB > Request Money to userB in a non-US currency. Be sure to include a note for what the request is for, like Thursday lunch.
2. Verify that userB receives a report action like Requested $20 for Thursday lunch.
3. Settle up the above request, and verify that no errors are thrown.

Splitting Bills/Settling Up with different initial IOU currency/output currency

1. Sign into OldDot with userA and navigate to Settings > Policies > Individual > Your personal policy > Reports. Change the currency to EUR.
2. As userA, FAB > Request Money to userB in JPY. Be sure to include a note for what the request is for, like Thursday lunch.
3. Verify that userB receives a report action like Requested ¥2,000 for Thursday lunch. Verify that the amount in the actual IOU below this report action is correctly shown in EUR.
4. Settle up the above request, and verify that no errors are thrown.

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 / Chrome
  • iOS / native
  • iOS / 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 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 correct English and 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 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mweb_chrome.mov

Mobile Web - Safari

mweb_safari.mov

Desktop

desktop.mov

iOS

ios_native.mov

Android

android.mov

[github-actions]

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

[MelvinBot]

@Santhosh-Sellavel @dangrous One of you needs to 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]

[Santhosh-Sellavel]

I'll test it out when read PR comes off hold

[jasperhuangg]

@Santhosh-Sellavel I've updated the testing steps, good for another look! I took the HOLD off, turns out both these PRs need to be held on each other, but it's better for this one to go out first

[Santhosh-Sellavel]

All right thanks will test it out shortly

[Santhosh-Sellavel]

Can you resolve conflicts, please @jasperhuangg

[Santhosh-Sellavel]

bump @jasperhuangg

[luacmartins]

any updates on this one?

[Santhosh-Sellavel]

Seems Jasper is on OOO

[jasperhuangg]

https://github.com/Expensify/Auth/pull/7785 is on prod and I'm taking this off hold

cc @Julesssss @Santhosh-Sellavel @dangrous

@Santhosh-Sellavel you should be able to retest this, let me know if you're still running into that error

[Santhosh-Sellavel]

Cool testing this now!

[Santhosh-Sellavel]

@jasperhuangg This step is confusing

Verify that userB receives a report action like Requested ¥2,000 for Thursday lunch. Verify that the amount in the actual IOU below this report action is correctly shown in GBP.

User B is Currency is GBP right? Should it be like Verify the amount shown in user B's currency?

[jasperhuangg]

@Santhosh-Sellavel There should be some text above the IOU action in Japanese Yen like Requested ¥2,000 for Thursday lunch. But the actual amount on the IOU report should be in GBP, does that make sense?

[Santhosh-Sellavel]

Why should be in GBP? I don't get the context User A's currency is EUR. So it should be shown in EUR or JPY or whatever the currency of User B. Confused

[Santhosh-Sellavel]

Normal

Screen.Recording.2023-04-29.at.1.50.51.AM.mov

Currency Change Flow

Screen.Recording.2023-04-29.at.2.02.14.AM.mov

[Santhosh-Sellavel]

Verify that userB receives a report action like Requested ¥2,000 for Thursday lunch. Verify that the amount in the actual IOU below this report action is correctly shown in EUR.

For some time the report action is shown in JPY is that fine or an issue? Check the above video

@jasperhuangg

[jasperhuangg]

@Santhosh-Sellavel that's fine

[jasperhuangg]

Why should be in GBP? I don't get the context User A's currency is EUR. So it should be shown in EUR or JPY or whatever the currency of User B. Confused

Sorted this out via DMs, there was a typo in the testing instructions.

[Santhosh-Sellavel]

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 / Chrome
  • iOS / native
  • iOS / 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(themeColors.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 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

Including Web/Desktop alone as changes don't affect UI.
Added here

Note:
Reason for being unable to include other screens, as I running into some unrelated issues while running native builds. If resolved will try to update but that's not a blocker here.

[Santhosh-Sellavel]

LGTM, thanks!

All yours @dangrous or @Julesssss!

[MelvinBot]

🎯 @Santhosh-Sellavel, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #18166.

[jasperhuangg]

@dangrous @Julesssss This PR should be ready to go, let's get it merged!

[dangrous]

LGTM!

[luacmartins]

Gonna merge this since we have 3 approvals.

[luacmartins]

Actually, I'll let @Julesssss do a final review since he encountered some issues that I couldn't reproduce.

[Julesssss]

Yep, it's on my list for today. Catching up after UK bank holiday.

[Julesssss]

I retested all the test cases today and it's working as expected 👍

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.9-12 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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