Fix new individual invoice after one is paid as a business #54138

neil-marcellini · 2024-12-13T22:34:52Z

Explanation of Change

The main change is ReportUtils.getInvoiceChatByParticipants, which now must have a receiverType passed. That fixes the root cause of the linked issue, because now this function will only get a report with the proper receiver type. Previously, after one invoice was sent to and individual and then paid as a business, sending another invoice to the individual would incorrectly try to use the converted invoice chat, which caused a backend error. Now the function will not find an individual invoice chat, and correctly create a new one. I added a unit test in ReportUtilsTest using data from manual testing which is stored in tests/data/Invoice.ts. That data included some fields which were not part of the type definitions, so I added those and had to adjust types in a few other places.

Fixed Issues

$ #53019
$ https://github.com/Expensify/Expensify/issues/401789
PROPOSAL: #53019 (comment)

Tests

Go to staging.new.expensify.com
Create a workspace if needed
Go to More features, scroll down and enable Invoices
Click green plus, Send invoice
Send an invoice to User B
As User B Go to invoice chat and pay the invoice as business
[User A] Go to invoice report
[User A] Click Add bank account
[User A] In settings Add bank account
Click on the bank account for invoicing and choose to make it the default
Click the green plus, send a $2 to user B
Open the invoice report and verify it loads successfully

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

I only tested on Mac Chrome because the changes are to one function that is platform independent.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

2024-12-17_10-29-13.mp4

MacOS: Desktop

neil-marcellini · 2024-12-17T23:32:19Z

Hi, this is ready for review now. The lint check is failing due to new rules about defaulting IDs, but I didn't add any of that. It already exists on main in some of the files I touched. I tried fixing it, but it creates a cascading effect of more and more files to fix and I don't want to get stuck in that rabbit hole.

Let's please get this issue fixed, then fix the lint check separately since that will be a huge PR.

melvin-bot · 2024-12-17T23:32:32Z

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

allgandalf · 2024-12-18T06:27:08Z

Can you fix the failing ESLint test here please

allgandalf · 2024-12-19T17:41:58Z

This has conflicts 😞

neil-marcellini · 2024-12-23T15:45:30Z

Can you fix the failing ESLint test here please

Please see this comment. I resolved the merge conflicts.

allgandalf · 2024-12-23T17:57:08Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Screen.Recording.2024-12-25.at.8.45.12.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-12-25.at.8.48.45.PM.mov

iOS: Native

Screen.Recording.2024-12-25.at.7.58.17.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-12-25.at.7.59.50.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-25.at.7.51.40.PM.mov

MacOS: Desktop

Screen.Recording.2024-12-25.at.7.55.27.PM.mov

allgandalf · 2024-12-24T06:37:42Z

tests/data/Invoice.ts

+    lastActorAccountID: 32,
+    lastMessageHtml: 'paid $1.00',
+    lastMessageText: 'paid $1.00',
+    lastMessageTranslationKey: '',


Suggested change

lastMessageTranslationKey: '',

Details for this change shared 1:1 on slack

allgandalf

LGTM overall, only one comment I will complete the checklist either ways

allgandalf · 2024-12-24T17:04:35Z

src/libs/actions/IOU.ts

+        Log.warn('getReceiverType called with no receiverParticipant');
+        return CONST.REPORT.INVOICE_RECEIVER_TYPE.INDIVIDUAL;
+    }
+    if ('type' in receiverParticipant && receiverParticipant.type) {


I guess optional chaining was troubling here 😆

Yes the type narrowing seems to be necessary because the receiverParticipant is a combination of two types.

allgandalf · 2024-12-24T17:08:05Z

src/types/utils/whitelistedReportKeys.ts

@@ -63,6 +63,8 @@ type WhitelistedReport = OnyxCommon.OnyxValueWithOfflineFeedback<
        };
        // eslint-disable-next-line @typescript-eslint/naming-convention
        private_isArchived: unknown;
+        state: unknown;
+        welcomeMessage: unknown;


Did we add these keys in the OpenApp call ?:

I think this comment is strange. The whole thing is pretty confusing. It's just listing all the fields in the report and asserting that they're in the report type. I don't find any value in that because it's totally circular.

I found the related issue, and the goal there is to move client only keys out of the report type. So now I understand the purpose. It also doesn't really make sense to limit that to the OpenApp call, I think OpenReport is also a valid way to tell which keys come from the server. I checked the response and I see that welcomeMessage is returned but state is not, so I'll remove state.

Thanks for pointing this out.

allgandalf · 2024-12-25T13:34:27Z

and we have conflicts...

allgandalf · 2024-12-25T13:35:00Z

Don't think those conflicts are any major thing, so i will continue with uploading the videos

allgandalf

LGTM! Tests well, lets fix the conflicts and we can merge 🚀

melvin-bot · 2024-12-26T18:35:07Z

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

allgandalf · 2024-12-26T18:36:29Z

Please ignore the failing es lint @puneetlath , have a look at this comment

melvin-bot · 2024-12-26T22:04:31Z

@puneetlath looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

puneetlath · 2024-12-26T22:04:47Z

Merged even though ESLint was failing based on this reasoning.

OSBotify · 2024-12-26T22:15:23Z

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

github-actions · 2024-12-31T22:17:37Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.80-1 🚀

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

izarutskaya · 2025-01-02T10:08:02Z

@neil-marcellini This PR is failing with issue #54723

https://platform.utest.com/services/links/v1/internal/55801408?.mp4

neil-marcellini added 6 commits December 13, 2024 12:53

Failing test only returns invoice chat when receiver type matches

bac1302

Fix test, require invoice receiver to match

59d79fa

WIP test getSendMoneyInvoiceInformation

0afdca3

WIP test via sendInvoice

3054897

Fix test, remove extra expected param

401f5de

Pass proper invoice receiver type

3d11b6c

neil-marcellini self-assigned this Dec 13, 2024

neil-marcellini added 12 commits December 13, 2024 15:02

WIP fix some types

03c9bf9

Add doc comment to make function more clear

0c6e50d

Fix receiver type getting B2B invoice room

a2bbb54

Major clean up of tests and types and lint

410868e

Jest matcher returns any so cast to fix type error

57ba052

Undo edge case type changes

e6d5a92

More type fixes

2ada6b8

Fix lint

3e4e033

Fix test, bad import path

4516d8f

Fix accidentally changed comment

17d298a

Merge branch 'main' into neil-fix-getInvoiceChatByParticipants

5fefb6c

Fix style

b62ad1b

neil-marcellini marked this pull request as ready for review December 17, 2024 23:32

neil-marcellini requested a review from a team as a code owner December 17, 2024 23:32

melvin-bot bot requested a review from allgandalf December 17, 2024 23:32

melvin-bot bot removed the request for review from a team December 17, 2024 23:32

Merge main to fix conflicts

7275ccf

allgandalf reviewed Dec 24, 2024

View reviewed changes

neil-marcellini added 2 commits December 24, 2024 07:12

Merge main to fix types

68cabf2

Remove field no longer present on type

b89a319

neil-marcellini requested a review from allgandalf December 24, 2024 15:13

allgandalf reviewed Dec 24, 2024

View reviewed changes

Remove accidentally added client only Report key state

55572c3

neil-marcellini requested a review from allgandalf December 24, 2024 19:21

allgandalf reviewed Dec 25, 2024

View reviewed changes

Merge branch 'main' into neil-fix-getInvoiceChatByParticipants

3e56f47

neil-marcellini requested a review from allgandalf December 26, 2024 14:58

allgandalf approved these changes Dec 26, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath December 26, 2024 18:35

puneetlath approved these changes Dec 26, 2024

View reviewed changes

puneetlath merged commit 116dbd4 into main Dec 26, 2024
17 of 18 checks passed

puneetlath deleted the neil-fix-getInvoiceChatByParticipants branch December 26, 2024 22:04

melvin-bot bot added the Emergency label Dec 26, 2024

puneetlath removed the Emergency label Dec 26, 2024

github-actions bot mentioned this pull request Dec 31, 2024

Deploy Checklist: New Expensify 2024-12-31 #54686

Open

68 tasks

IuliiaHerets mentioned this pull request Jan 1, 2025

Invoice - The Add bank account button is not displayed in the invoice report #54723

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix new individual invoice after one is paid as a business #54138

Fix new individual invoice after one is paid as a business #54138

neil-marcellini commented Dec 13, 2024 •

edited

Loading

neil-marcellini commented Dec 17, 2024

melvin-bot bot commented Dec 17, 2024

allgandalf commented Dec 18, 2024

allgandalf commented Dec 19, 2024

neil-marcellini commented Dec 23, 2024

allgandalf commented Dec 23, 2024 •

edited

Loading

allgandalf Dec 24, 2024

allgandalf left a comment

allgandalf Dec 24, 2024

neil-marcellini Dec 24, 2024

allgandalf Dec 24, 2024

neil-marcellini Dec 24, 2024

allgandalf commented Dec 25, 2024

allgandalf commented Dec 25, 2024 •

edited

Loading

allgandalf left a comment

melvin-bot bot commented Dec 26, 2024

allgandalf commented Dec 26, 2024

melvin-bot bot commented Dec 26, 2024

puneetlath commented Dec 26, 2024

OSBotify commented Dec 26, 2024

github-actions bot commented Dec 31, 2024

izarutskaya commented Jan 2, 2025

Fix new individual invoice after one is paid as a business #54138

Fix new individual invoice after one is paid as a business #54138

Conversation

neil-marcellini commented Dec 13, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

neil-marcellini commented Dec 17, 2024

melvin-bot bot commented Dec 17, 2024

allgandalf commented Dec 18, 2024

allgandalf commented Dec 19, 2024

neil-marcellini commented Dec 23, 2024

allgandalf commented Dec 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allgandalf Dec 24, 2024

Choose a reason for hiding this comment

allgandalf left a comment

Choose a reason for hiding this comment

allgandalf Dec 24, 2024

Choose a reason for hiding this comment

neil-marcellini Dec 24, 2024

Choose a reason for hiding this comment

allgandalf Dec 24, 2024

Choose a reason for hiding this comment

neil-marcellini Dec 24, 2024

Choose a reason for hiding this comment

allgandalf commented Dec 25, 2024

allgandalf commented Dec 25, 2024 • edited Loading

allgandalf left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 26, 2024

allgandalf commented Dec 26, 2024

melvin-bot bot commented Dec 26, 2024

puneetlath commented Dec 26, 2024

OSBotify commented Dec 26, 2024

github-actions bot commented Dec 31, 2024

izarutskaya commented Jan 2, 2025

neil-marcellini commented Dec 13, 2024 •

edited

Loading

allgandalf commented Dec 23, 2024 •

edited

Loading

allgandalf commented Dec 25, 2024 •

edited

Loading