Accept receipt in request money #23770

luacmartins · 2023-07-27T22:33:41Z

Details

Sends the receipt to the API

Fixed Issues

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

Tests

Request money from another user + > Request money
Select scan
Upload a receipt image (it can be any image really)
Open the browser console
Submit the request
Verify that the RequestMoney request has receipt: (binary) in the request params
Verify that the created transaction in Onyx has the receipt key with the source and state keys

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

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

![Screenshot 2023-08-02 at 5 24 08 PM](https://github.com/Expensify/App/assets/22219519/fbb87117-eb8b-4315-b1e4-0d01e7b59d9f)

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

luacmartins · 2023-08-02T23:22:53Z

I think this PR is ready for review! The API command will fail with 405 invalid amount since the API is not implemented yet, but this feature is behind a beta, so all we need to make sure here is that we're sending the binary file as a request param and the new Onyx transaction has a receipt key with the right properties

melvin-bot · 2023-08-02T23:36:06Z

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

dylanexpensify · 2023-08-03T08:18:09Z

@abdulrahuman5196 let's get to reviewing this ASAP if you can please! Top priority here! ❤️ 🙇‍♂️

abdulrahuman5196 · 2023-08-03T08:52:57Z

Sure @dylanexpensify Will take this as priority

src/libs/actions/IOU.js

abdulrahuman5196 · 2023-08-03T09:27:50Z

src/libs/fileDownload/FileUtils.js

+            })
+            .catch((e) => {
+                console.debug('[FileUtils] Could not read uploaded file', e);
+                resolve();


We are resolving even on failures? Shouldn't we reject?

We resolve with an undefined receipt file and the call to RequestMoney proceeds without the receipt.

I agree that we should eventually reject and display some error to the user, but I didn't see anything about it in the doc. Since this PR is blocking others in this project and we currently don't display errors in MoneyRequestConfirmPage, I think we should keep the scope of this PR smaller and tackle displaying an error as a follow up once we align on what error will be displayed.

Got it. Fine by me then.

src/pages/iou/steps/MoneyRequestConfirmPage.js

luacmartins · 2023-08-03T17:16:05Z

Added to the beta and addressed comments.

abdulrahuman5196 · 2023-08-03T18:07:49Z

Thank you @luacmartins Will test this PR and update if any issue.

Gonals

Tests well and looks great!

abdulrahuman5196 · 2023-08-03T18:39:11Z

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

Web

Screen.Recording.2023-08-04.at.12.18.29.AM.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-08-04.at.12.25.22.AM.mp4

iOS

Android

abdulrahuman5196 · 2023-08-03T19:02:31Z

On a side note the API is failing. I assume the End to End working is not complete yet and out of the scope of this PR.

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @luacmartins Good to merge.

🎀 👀 🎀
C+ Reviewed

melvin-bot · 2023-08-03T19:05:31Z

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

melvin-bot · 2023-08-03T19:05:35Z

🎯 @abdulrahuman5196, thanks for reviewing and testing this PR! 🎉

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

dylanexpensify · 2023-08-03T19:36:29Z

Incredible work!!

OSBotify · 2023-08-03T19:40:02Z

✋ 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 · 2023-08-07T18:56:04Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.51-0 🚀

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

OSBotify · 2023-08-09T08:45:12Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

OSBotify · 2023-08-09T09:14:17Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-09T09:53:00Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-10T20:11:26Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

s77rt · 2023-10-04T17:21:31Z

src/libs/fileDownload/FileUtils.js

+                return res.blob();
+            })
+            .then((blob) => {
+                const file = new File([blob], cleanFileName(fileName));


This caused a bug #26940. On Android the File API constructor needs the type to be specified otherwise network uploads would fail.

mollfpr · 2023-10-25T13:47:33Z

src/pages/iou/steps/MoneyRequestConfirmPage.js

-                trimmedComment,
-            );
+            if (props.iou.receiptPath && props.iou.receiptSource) {
+                FileUtils.readFileAsync(props.iou.receiptPath, props.iou.receiptSource).then((receipt) => {


✋ Coming from #28347

The transaction creation with receipt upload won't work after uploading the receipt and refreshing the page because the file is removed. So we decided to check the file, if the file is not available then we navigated back the user to the main request money page.

luacmartins added 7 commits July 27, 2023 15:54

pass receipt param

89ce236

create buildOptimisticReceipt

94ccccc

move buildOptimisticReceipt logic

eafded7

add receipt to buildOptimisticIOUReportAction

af581b4

create single optimisticReceipt

1f7f7bd

rm unsued import

3715973

add more checks to buildOptimisticReceipt

991fc6a

luacmartins self-assigned this Jul 27, 2023

luacmartins added 2 commits July 27, 2023 16:34

update comment

7c88271

fix style

c075113

luacmartins requested a review from Gonals July 28, 2023 17:00

luacmartins added 10 commits July 31, 2023 15:49

rm buildOptimisticReceipt

0a3cd9b

create readFileAsync

448813c

update comment

43922f7

read uploaded receipt

551af16

resolve conflicts

b595397

fix style

bbeb8cc

add path to file

71a8481

pass receipt as correct param

0c5f0c2

fix tests

576c4de

resolve conflicts

601dccc

luacmartins marked this pull request as ready for review August 2, 2023 23:36

luacmartins requested a review from a team as a code owner August 2, 2023 23:36

melvin-bot bot removed the request for review from a team August 2, 2023 23:36

melvin-bot bot requested a review from abdulrahuman5196 August 2, 2023 23:36

abdulrahuman5196 suggested changes Aug 3, 2023

View reviewed changes

only call readfile when receipt is present

68afecf

luacmartins requested a review from abdulrahuman5196 August 3, 2023 17:16

AndrewGable self-requested a review August 3, 2023 17:59

Gonals approved these changes Aug 3, 2023

View reviewed changes

abdulrahuman5196 approved these changes Aug 3, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham August 3, 2023 19:05

melvin-bot bot mentioned this pull request Aug 3, 2023

[hold for payment aug 16th]Payment issue for E/App PR#23770 #24127

Closed

luacmartins merged commit f3ece51 into main Aug 3, 2023

luacmartins deleted the cmartins-requestMoneyReceipt branch August 3, 2023 19:35

luacmartins mentioned this pull request Aug 4, 2023

[HOLD for payment 2023-11-21] [$250] Add error handling to readFilyAsync #24141

Closed

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

s77rt reviewed Oct 4, 2023

View reviewed changes

s77rt mentioned this pull request Oct 4, 2023

[HOLD for payment 2023-10-10] [$1000] Android - Request money - IOU SmartScan disappears from the history when a user is relogged #26940

Closed

6 tasks

mollfpr reviewed Oct 25, 2023

View reviewed changes

mollfpr mentioned this pull request Oct 25, 2023

[HOLD for payment 2023-10-25] [$500] IOU - Request money is not successful after refreshing in confirm page #28347

Closed

6 tasks

DylanDylann mentioned this pull request Nov 3, 2023

Fix/24141: Add error handling to readFilyAsync #30832

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Accept receipt in request money #23770

Accept receipt in request money #23770

luacmartins commented Jul 27, 2023 •

edited

Loading

luacmartins commented Aug 2, 2023

melvin-bot bot commented Aug 2, 2023

dylanexpensify commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

abdulrahuman5196 Aug 3, 2023

luacmartins Aug 3, 2023

abdulrahuman5196 Aug 3, 2023

luacmartins commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

Gonals left a comment

abdulrahuman5196 commented Aug 3, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 3, 2023

abdulrahuman5196 left a comment

melvin-bot bot commented Aug 3, 2023

melvin-bot bot commented Aug 3, 2023

dylanexpensify commented Aug 3, 2023

OSBotify commented Aug 3, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

s77rt Oct 4, 2023 •

edited

Loading

mollfpr Oct 25, 2023

Accept receipt in request money #23770

Accept receipt in request money #23770

Conversation

luacmartins commented Jul 27, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

luacmartins commented Aug 2, 2023

melvin-bot bot commented Aug 2, 2023

dylanexpensify commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

abdulrahuman5196 Aug 3, 2023

Choose a reason for hiding this comment

luacmartins Aug 3, 2023

Choose a reason for hiding this comment

abdulrahuman5196 Aug 3, 2023

Choose a reason for hiding this comment

luacmartins commented Aug 3, 2023

abdulrahuman5196 commented Aug 3, 2023

Gonals left a comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Aug 3, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 commented Aug 3, 2023

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 3, 2023

melvin-bot bot commented Aug 3, 2023

dylanexpensify commented Aug 3, 2023

OSBotify commented Aug 3, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

s77rt Oct 4, 2023 • edited Loading

Choose a reason for hiding this comment

mollfpr Oct 25, 2023

Choose a reason for hiding this comment

luacmartins commented Jul 27, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 3, 2023 •

edited

Loading

s77rt Oct 4, 2023 •

edited

Loading