Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace receipt #26508

Merged
merged 34 commits into from
Sep 20, 2023
Merged

Replace receipt #26508

merged 34 commits into from
Sep 20, 2023

Conversation

luacmartins
Copy link
Contributor

@luacmartins luacmartins commented Sep 1, 2023

Details

Adds the ability to replace transaction receipts

Fixed Issues

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

Tests

  1. Request money via Scan option
  2. Tap the report preview
  3. Tap the request preview
  4. Tap the receipt image
  5. When the modal opens, tap the three dot menu at the top
  6. Select replace
  7. verify that receipt selector opens in the right hand modal
  8. Select a new receipt
  9. Verify that the receipt is updated
  10. Log out and log back in
  11. Verify that the new receipt still shows up
  • 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 / 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 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

I'm having issues building iOS and android native at the moment. I'll try to upload the videos later.

Web
web.mov
Mobile Web - Chrome
chrome.mov
Mobile Web - Safari
safari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

@luacmartins luacmartins self-assigned this Sep 1, 2023
@luacmartins luacmartins changed the title create EditRequestReceiptPage Replace receipt Sep 1, 2023
@luacmartins luacmartins marked this pull request as ready for review September 11, 2023 05:40
@luacmartins luacmartins requested a review from a team as a code owner September 11, 2023 05:40
@melvin-bot melvin-bot bot requested review from rushatgabhane and removed request for a team September 11, 2023 05:41
@luacmartins
Copy link
Contributor Author

luacmartins commented Sep 19, 2023

Ok, I think the web issues are gone after merging main. Gonna look into the cross platform issue now

@luacmartins
Copy link
Contributor Author

I was able to test on iOS and I do see the image being updated on web.

Android simulator is giving me a lot of headaches with the bad internet connection in Bali, so I'm not able to reliably test this condition. This PR is blocking others, so given that it's working on all platforms but android I think we should go ahead and merge this PR and then address the issue in a follow up if we encounter it on staging

ios.web.mov

Copy link
Contributor

@Gonals Gonals left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good! Just one question and I'll jump to testing

@@ -331,6 +338,10 @@ function AttachmentModal(props) {
}}
onModalHide={(e) => {
props.onModalHide(e);
if (onModalHideCallbackRef.current) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this do?

@Gonals
Copy link
Contributor

Gonals commented Sep 19, 2023

Tests well, but Android is also being a pain for me. I'm ok merging this

@burczu
Copy link
Contributor

burczu commented Sep 19, 2023

I don't know what to do with this. For me it works very unpredictable and I'm not sure if I want to take responsibility for approving this...

@burczu
Copy link
Contributor

burczu commented Sep 19, 2023

Another issue, this time on iOS:

Screen.Recording.2023-09-19.at.08.37.37.mov

@MariaHCD
Copy link
Contributor

@burczu could you clarify what you mean by:

For me it works very unpredictable

Happy to help test here, if needed, @luacmartins.

@burczu
Copy link
Contributor

burczu commented Sep 19, 2023

@MariaHCD I encountered some issues (you can see my comments in the thread above), that I don't see resolved. If you like to test it, go on - maybe it's the matter of my environment. Right now I'm struggling with Android build so I can't get back to this PR at the moment.

@burczu
Copy link
Contributor

burczu commented Sep 19, 2023

@luacmartins I've cleaned my environment and re-tested everything with new user. Web is now working as expeced, as well as on Android. The only issue I have is with iOS - please see this comment. It sometimes work but in most cases it throws an error of "Unhandled Promise Rejection".

@luacmartins
Copy link
Contributor Author

That error points to this fetch call failing with a Networks request failed error. We have this issue to better handle errors in readFileAsync so I don't think that's a blocker for this issue.

@luacmartins
Copy link
Contributor Author

@MariaHCD I'd love another review here so we can get this merged asap.

Copy link
Contributor

@burczu burczu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, I was able to successfully replace the image on iOS so I think I can approve it... I'm not sure how improving error handling will fix the issue with rejecting this Promise, because I guess the question is why it is rejected not how it is handled...

@melvin-bot melvin-bot bot requested a review from Li357 September 20, 2023 07:27
@melvin-bot
Copy link

melvin-bot bot commented Sep 20, 2023

@Li357 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
Copy link

melvin-bot bot commented Sep 20, 2023

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

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

@luacmartins
Copy link
Contributor Author

Yea, that makes sense. I'll investigate that as part of the other issue!

@luacmartins luacmartins merged commit a29650f into main Sep 20, 2023
11 of 14 checks passed
@luacmartins luacmartins deleted the cmartins-replaceReceipt branch September 20, 2023 07:44
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.72-11 🚀

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

icon: Expensicons.Camera,
text: props.translate('common.replace'),
onSelected: () => {
onModalHideCallbackRef.current = () => Navigation.navigate(ROUTES.getEditRequestRoute(props.report.reportID, CONST.EDIT_REQUEST_FIELD.RECEIPT));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This caused #27903 when navigating to the replace receipt screen not from within a tab navigator, i.e. whenever clicking from the three dots menu.

Comment on lines +35 to +44
<HeaderWithBackButton
title={translate('common.receipt')}
onBackButtonPress={Navigation.goBack}
/>
<DragAndDropProvider>
<ReceiptSelector
route={route}
transactionID={transactionID}
/>
</DragAndDropProvider>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This causes an inconsistency issue here where the Green drag and drop area does not show in full-screen #28014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants