Feat: update the report when a payment is refunded

[getusha]

Details

Fixed Issues

$ #29319
PROPOSAL: N/A

Tests

Same as QA

• Verify that no errors appear in the JS console

Offline tests

Same as QA

QA Steps

Internal QA, can be tested once this backend PR is deployed.

1. Open any app
2. Open IOU where it's cancelled due to by not enabling Expensify Wallet within 30 days
3. Verify that there is a message like Canceled the $2.00 payment, because [email protected] did not enable their Expensify Wallet within 30 days
   

• 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 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

Screen.Recording.2023-11-28.at.2.47.38.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-11-28.at.1.20.59.PM.mov

MacOS: Desktop

[melvin-bot]

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

[robertKozik]

@getusha How can I test this PR?

[MariaHCD]

@robertKozik If you can do a code review, I can handle testing on all platforms since we don't have the backend pieces for this just yet.

[robertKozik]

Sure!

[robertKozik]

These two types are the same, can we merged them?

[getusha]

@robertKozik

App/src/languages/types.ts

Line 103 in ba75ce9

type RequestAmountParams = {amount: number};

App/src/languages/types.ts

Line 109 in ba75ce9

type AmountEachParams = {amount: number};

App/src/languages/types.ts

Line 107 in ba75ce9

type SplitAmountParams = {amount: number};

there are a lot of duplicate types, don't you think its better to keep it for its clear naming? if we want to add another param it'll be easier since we have types for each function, if not what should we name the type after combining it as one.

[robertKozik]

Ok, makes sense, lets keep it as it is

[robertKozik]

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(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 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 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

Web

Mobile Web - Chrome

Screen.Recording.2023-11-28.at.4.12.18.PM.mov

Mobile Web - Safari

Desktop

iOS

Android

Screen.Recording.2023-11-28.at.4.26.14.PM.mov

Screen.Recording.2023-11-28.at.4.27.18.PM.mov

[robertKozik]

Code looks good

[MariaHCD]

@getusha can you merge main here? 🙏🏼

[getusha]

@getusha can you merge main here? 🙏🏼

@MariaHCD Merged main.

[MariaHCD]

@getusha I added a REIMBURSEMENTDEQUEUED action to an IOU report with this information:

The report action is shown without the amount and payee's email, is there something I'm missing?

[getusha]

I was seeing something like this, i think we should use props.report instead of props.iouReport, could you share how you added the action to an IOU report?

[MariaHCD]

could you share how you added the action to an IOU report?

I added a mock report action in my local dev database 😅

Do you know of a way to manually add Onyx data?

[getusha]

@MariaHCD Let me try setting it using Onyx.merge, can you send me the full mock data you used?

[MariaHCD]

Mock data (you will have to change the accountIDs, reportIDs, etc.)

{
  "9223114381001494361": {
    "person": [
      {
        "type": "TEXT",
        "style": "strong",
        "text": "Platinum User"
      }
    ],
    "actorAccountID": 9412,
    "message": [
      {
        "type": "TEXT",
        "style": "strong",
        "text": "You"
      },
      {
        "type": "TEXT",
        "style": "normal",
        "text": " cancelled the reimbursement"
      }
    ],
    "originalMessage": {
      "IOUReportID": 684660233193177,
      "lastModified": "2023-10-17 14:14:52",
      "reason": "CANCEL_REASON_PAYMENT_EXPIRED"
    },
    "avatar": "https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/default-avatar_19.png",
    "created": "2023-10-17 14:14:52",
    "timestamp": 1697552092,
    "reportActionTimestamp": 1697552092000,
    "automatic": false,
    "actionName": "REIMBURSEMENTDEQUEUED",
    "shouldShow": true,
    "reportActionID": "9223114381001494361",
    "previousReportActionID": "5326942128745065457",
    "lastModified": "2023-10-17 14:14:52",
    "whisperedToAccountIDs": []
  },
}

[getusha]

@MariaHCD changed some things, can you test it again? 🙇
Also it would be great if you can share the value of props.report and props.iouReport i am assuming it'll be the same for type REIMBURSEMENTQUEUED

[MariaHCD]

Apologies for the delay here, @getusha! I've retested and it looks better:

What the payee/recipient sees:

What the payer sees:

[MariaHCD]

Let's update the header and the title in the LHN to match pending IOUs:

[MariaHCD]

Lint errors 😬

[MariaHCD]

@robertKozik could you give this another review? We've made some updates since your last review.

[MariaHCD]

One thing I noticed, @getusha, the IOU in the LHN doesn't show Canceled until you open the report. Once the report is opened, the last message showed in the LHN is the user's email when it should be Canceled the $2.00 payment, ...

Payee:

Screen.Recording.2023-11-28.at.3.41.19.PM.mov

Payer (Title in the LHN shows correctly but the last message is the payee's email, is that expected?):

Screen.Recording.2023-11-28.at.3.47.14.PM.mov

[robertKozik]

Sure I'll schedule it for today @MariaHCD. Are we still talking about only code review, or maybe backend is deployed and I should test cases as well?

[MariaHCD]

Just the code review for now, @robertKozik. Thanks! I'm updating the reviewer checklist with screens/videos of my tests

[getusha]

the IOU in the LHN doesn't show Canceled until you open the report

@MariaHCD my understanding is that the REIMBURSEMENTDEQUEUED action won't be loaded until we open the report, unless we open it we can't check if the action exists. we are using the reportID from iouReport, i thin the LHN shows pending before opening the report because it is using isWaitingOnBankAccount prop.

[getusha]

Once the report is opened, the last message showed in the LHN is the user's email when it should be Canceled the $2.00 payment, ...

Fixed this one.

[MariaHCD]

the REIMBURSEMENTDEQUEUED action won't be loaded until we open the report, unless we open it we can't check if the action exists

Ah, I see. That makes sense. Then, like you suggested before, adding a new prop from the backend (like isCancelled) might be the ideal solution here. Let me look into the backend changes required.

[MariaHCD]

@getusha I've added a new prop isCancelledIOU in my dev backend. Let me know what you think. The ngrok URL I shared with you previously should still be working.

[MariaHCD]

Tests well and backend changes are out for review:

• https://github.com/Expensify/Auth/pull/9299
• https://github.com/Expensify/Web-Expensify/pull/39878

Final review, please, @robertKozik!

[robertKozik]

Code-wise looks good to me as well

[melvin-bot]

We did not find an internal engineer to review this PR, trying to assign a random engineer to #29319 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

[OSBotify]

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.4.7-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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