Implement Invoice rooms with individual receivers #40303

rezkiy37 · 2024-04-16T17:19:49Z

Details

The PR introduces an invoice room UI and invoice report. The app gathers all info from those reports to render proper UI/UX.

Fixed Issues

$ #40013
PROPOSAL: N/A

Tests

Note: the backend is not ready yet. So you can safely test only in offline.
Note: this PR depends on #40015. So until the PR is not merged, you need pull it manually to this for testing.

Send an invoice.
Verify that the app redirects to an invoice room.
Verify that the rooms and actions looks properly.
Click on an invoice report preview.
Verify that the invoice report looks properly.

Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

QA Steps

Same as "Tests".

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.mp4

Android: mWeb Chrome

Android.Chrome.mp4

iOS: Native

iOS: mWeb Safari

IOS.Safari.mp4

MacOS: Chrome / Safari

Chrome.mp4

MacOS: Desktop

Desktop.mp4

…-rooms-individual-receivers-2

cristipaval · 2024-04-26T21:02:26Z

@rushatgabhane I just fixed the TS issues and also resolved conflicts with main. Could you please review/test again?

…-rooms-individual-receivers-2

cristipaval · 2024-04-27T11:09:45Z

Ok, so @rushatgabhane, here is the plan:

Use this PR to send some invoices from a workspace to some individuals. The backend will create invoice rooms between the sender workspace and each individual
Check out this branch and do the testing. If it's a PASS, then we merge this PR because it won't affect the staging and prod builds because there are no invoice rooms in production yet

rushatgabhane · 2024-04-28T07:20:52Z

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

LGTM!

cristipaval

Thanks a lot!

OSBotify · 2024-04-28T10:47:24Z

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

shawnborton · 2024-04-29T16:39:25Z

Did we end up getting rid of the single type tab above the invoice amount? I can't tell from recent screenshots:

shawnborton · 2024-04-29T16:40:54Z

Also, can you share screenshots of what all of the room avatars will look like? I know @puneetlath had some feedback about which kinds of avatars to use for the invoice rooms, and I'm not sure if that feedback was addressed here or not.

VickyStash · 2024-04-29T17:39:04Z

Did we end up getting rid of the single type tab above the invoice amount? I can't tell from recent screenshots:

@shawnborton Yes, there is no Manual tab

shawnborton · 2024-04-29T17:40:36Z

Awesome, thanks for confirming.

OSBotify · 2024-04-29T23:33:57Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 1.4.67-7 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-04-30T01:13:54Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.68-0 🚀

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

OSBotify · 2024-04-30T02:34:42Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 1.4.67-7 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-05-01T02:38:04Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.68-3 🚀

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

ahmedGaber93 · 2024-07-16T11:38:13Z

This issue missed handling mentioning Invoice rooms that appear as "Chat Report" in room mention list, and it handled here #43988

rayane-djouah · 2024-08-02T16:43:23Z

FYI, this PR missed to update the getChatByParticipants function to exclude the invoice room report type, which caused this bug: #45187. More info in this proposal: #45187 (comment).

jayeshmangwani · 2024-08-12T13:58:40Z

In this PR missed to exclude the invoice room report type in the canDeleteReportAction function, which caused the bug #45632 where the Delete Expense option is visible for the invoice type system message.

rezkiy37 added 30 commits April 16, 2024 19:03

add invoice chat type

93292f7

add invoice report type

1c17dd6

create isInvoiceRoom and isInvoiceReport

08c640b

check isInvoiceReport in report screen

10c2d2f

check that invoice room is chat room

5022a11

implement invoice room welcome message

86f52ca

accept invoice report in AvatarWithDisplayName

f9243bb

support invoice report in getChatRoomSubtitle

c15f33d

accept invoice room in shouldReportShowSubscript

e08889e

integrate invoice room in canLeaveRoom

2d67b99

integrate invoice icon in getIcons

3e94616

create getInvoicesChatName

8a41a36

add awaiting payment translation

2446057

create PaymentWaitingBanner

8e66700

create isInvoiceAwaitingPayment

fd8a5bd

render MoneyRequestView in ReportActionItem for invoice

19175e9

add invoiceReceiver to report

21fb170

integrate invoiceReceiver usage

32536ff

add invoice banner to MoneyReportHeader

4bad9a2

integrate deleted invoice message

4e81a6c

integrate deleted invoice message in getTransactionReportName

19b54e3

add invoice banner to ReportPreview

ca98bd9

add todo

89e2eed

invoice is not a default for ReportWelcomeText

d83d22a

fix welcome message

b9ed19d

render proper welcome hero text

697de5e

render proper invoice room title

60462fd

integrate report subtitle for invoice room

a524346

integrate payer name

933499e

render proper actor of invoice

80dbeef

cristipaval requested a review from a team April 26, 2024 19:37

cristipaval added 2 commits April 26, 2024 22:57

Fix TS issues

396447f

Merge remote-tracking branch 'origin/main' into feature/40013-invoice…

7c8a492

…-rooms-individual-receivers-2

Merge remote-tracking branch 'origin/main' into feature/40013-invoice…

3844b32

…-rooms-individual-receivers-2

rushatgabhane approved these changes Apr 28, 2024

View reviewed changes

cristipaval approved these changes Apr 28, 2024

View reviewed changes

cristipaval merged commit 223672b into Expensify:main Apr 28, 2024
16 checks passed

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

Deploy Checklist: New Expensify 2024-04-29 #41266

Closed

74 tasks

This was referenced Apr 30, 2024

[HOLD for payment 2024-05-14][$250] Send invoice - Hide visibility and room name fields in the Settings page of the Invoice room #41280

Closed

Update invoice rooms to use correct avatars and show correct threads subtitles #41316

Merged

This was referenced May 7, 2024

[$250] Web -Send Invoice - Comments sent after an invoice get hidden when returning to invoice report #41318

Closed

[HOLD for payment 2024-06-11] [$250] Send invoice - (archived) is not appended to chat and Leave option is shown when WS is deleted #41306

Closed

iwiznia mentioned this pull request Jun 21, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] [$250] Send invoice - "Chat Report" appears in room mention list after sending invoice #43988

Closed

6 tasks

rayane-djouah mentioned this pull request Aug 2, 2024

[HOLD for payment 2024-08-01] [$250] Invoice - Invoice thread opens when starting DM with the user after sending invoice to them #45187

Closed

6 tasks

jayeshmangwani mentioned this pull request Aug 12, 2024

[HOLD for payment 2024-08-09] [$250] Invoice - There is "Delete expense" option in the invoice paid system message #45632

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Invoice rooms with individual receivers #40303

Implement Invoice rooms with individual receivers #40303

rezkiy37 commented Apr 16, 2024

cristipaval commented Apr 26, 2024

cristipaval commented Apr 27, 2024

rushatgabhane commented Apr 28, 2024 •

edited

Loading

rushatgabhane left a comment

cristipaval left a comment

OSBotify commented Apr 28, 2024

shawnborton commented Apr 29, 2024

shawnborton commented Apr 29, 2024

VickyStash commented Apr 29, 2024

shawnborton commented Apr 29, 2024

OSBotify commented Apr 29, 2024

OSBotify commented Apr 30, 2024

OSBotify commented Apr 30, 2024

OSBotify commented May 1, 2024

ahmedGaber93 commented Jul 16, 2024

rayane-djouah commented Aug 2, 2024

jayeshmangwani commented Aug 12, 2024

Implement Invoice rooms with individual receivers #40303

Implement Invoice rooms with individual receivers #40303

Conversation

rezkiy37 commented Apr 16, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

cristipaval commented Apr 26, 2024

cristipaval commented Apr 27, 2024

rushatgabhane commented Apr 28, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment

Choose a reason for hiding this comment

cristipaval left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 28, 2024

shawnborton commented Apr 29, 2024

shawnborton commented Apr 29, 2024

VickyStash commented Apr 29, 2024

shawnborton commented Apr 29, 2024

OSBotify commented Apr 29, 2024

OSBotify commented Apr 30, 2024

OSBotify commented Apr 30, 2024

OSBotify commented May 1, 2024

ahmedGaber93 commented Jul 16, 2024

rayane-djouah commented Aug 2, 2024

jayeshmangwani commented Aug 12, 2024

rushatgabhane commented Apr 28, 2024 •

edited

Loading