App icon indicating copy to clipboard operation
App copied to clipboard
verified publisher icon Expensify

Remove `MoneyRequestConfirmationList` and replace to `MoneyTemporaryForRefactorRequestConfirmationList`

Open brunovjk opened this issue 1 year ago • 1 comments

Details

This PR involves refactoring MoneyRequestConfirmationList component, used across various sections to confirm a request creation. Test it thoroughly in all relevant areas.

Fixed Issues

$ https://github.com/Expensify/App/issues/39559 PROPOSAL: https://github.com/Expensify/App/issues/39559#issuecomment-2035695512

Tests

  • Request Step Confirmation:
  1. Log in to the New Expensify App.
  2. Access different sections such as workspace chat, 1:1 chat, or the Global FAB. Test using each approach.
  3. Click on the + icon to create a request.
  4. Select either Money Request, Send Money, or Split Bill. Test each option.
  5. Choose between Manual, Scan, or Distance for request creation. Test each method. Testing steps:
  6. Progress through all request creation steps to reach the final Confirmation Page.
  7. Verify all options available on the final Confirmation Page.
  8. Confirm that everything functions as expected, maintaining the same behavior as before the refactoring.
  • Split Bill Details Page:
  1. Login to the New Expensify App.
  2. Navigate to a workspace chat where you are an admin.
  3. Click on the + icon.
  4. Select Split Bill.
  5. Choose between Manual, Scan, or Distance.
  6. Progress through all steps to reach the final Confirmation Page.
  7. Test all options available on the Confirmation Page.
  8. Access the newly created Split Report.
  9. Verify redirection to the Split Bill Details Page and confirm functionality remains consistent with pre-PR state.
  • [x] Verify that no errors appear in the JS console

Offline tests

Same as Tests

  • [x] Verify that no errors appear in the JS console

QA Steps

Same as Tests

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

brunovjk avatar Apr 12 '24 14:04 brunovjk

@eh2077 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[bot] avatar Apr 12 '24 14:04 melvin-bot[bot]

@eh2077 our PR is ready for review. Im struggling with my Android build, can you assist me with test/videos here? Thank you very much.

brunovjk avatar Apr 13 '24 22:04 brunovjk

@brunovjk I think we should test each IOU flow separately to ensure that these critical flows are not broken.

We have four IOU types, [send, split, request, track-expense], and three request types, [manual, scan, distance]. There're 10 flows in total

  1. send money - manual
  2. request money - manual
  3. request money - scan
  4. request money - distance in workspace
  5. split money - manual
  6. split money - scan
  7. split money - distance in workspace
  8. track-expense - manual
  9. track-expense - scan
  10. track-expense - distance

Would you like to update test steps?

eh2077 avatar Apr 15 '24 08:04 eh2077

@eh2077 I changed what you suggested, tested it on those 10 flows you mentioned and everything works fine now (creating and editing when enable). I only tested it on the Browser today, tomorrow I will come back and test it on the other platforms. I will update the 'Test' steps section and videos. Thank you very much for the review.

brunovjk avatar Apr 15 '24 23:04 brunovjk

@brunovjk Cool! Can you help update the those test steps also? So that I can also test them.

eh2077 avatar Apr 16 '24 00:04 eh2077

Can you help update the those test steps also? So that I can also test them.

Sure! All steps we found necessary are covered. They're a bit extensive now. If you find any unnecessary or redundant test cases, please let me know, and I'll make the adjustments. Thank you @eh2077.

brunovjk avatar Apr 16 '24 13:04 brunovjk

@brunovjk Thank you! Let me take some time to look into the code and test those flows.

eh2077 avatar Apr 16 '24 14:04 eh2077

Thank you! Let me take some time to look into the code and test those flows.

Awesome!!! Im here if you need anything. Have a good work.

brunovjk avatar Apr 16 '24 14:04 brunovjk

I compared following flows with production and confirmed they all work as expected

  1. Send Money (Global Fab)
  2. Request Money - Manual (Global Fab)
  3. Request Money - Scan (Global Fab)
  4. Request Money - Distance (Global Fab)
  5. Track Expense - Manual (Global Fab)
  6. Track Expense - Scan (Global Fab)
  7. Track Expense - Distance (Global Fab) Note: This feature is only available on main now
  8. Split Bill - Manual (Workspace Default Chat)
  9. Split Bill - Scan (Workspace Default Chat)
  10. Split Bill - Distance (Workspace Default Chat)

eh2077 avatar Apr 17 '24 08:04 eh2077

I'm working on the checklist.

eh2077 avatar Apr 17 '24 12:04 eh2077

@brunovjk I found a bug - [Request Money - Scan] uploading PDF receipt not working

https://github.com/Expensify/App/assets/117511920/8501d324-a063-4f71-9c6d-d4984e958d66

PDF files for testing

eh2077 avatar Apr 17 '24 15:04 eh2077

I found a bug - [Request Money - Scan] uploading PDF receipt not working

I can reproduce this bug on main: image @eh2077 I don't believe it's our PR that's causing it, but I'll try to investigate anyway.

EDIT: "There is a PR to fix it: https://github.com/Expensify/App/pull/40351"

brunovjk avatar Apr 17 '24 19:04 brunovjk

@brunovjk Thanks for starting this discussion on Slack! The fix PR https://github.com/Expensify/App/pull/40385 should be merged soon.

eh2077 avatar Apr 18 '24 07:04 eh2077

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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.
  • [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/117511920/f912ff5e-482c-46cf-aa8c-a6c9bdda4567

Android: mWeb Chrome

https://github.com/Expensify/App/assets/117511920/38a441d7-a4c1-42b8-bacb-7cec0ea5ebd4

iOS: Native

https://github.com/Expensify/App/assets/117511920/3c6d2580-7087-4327-a986-ea4a361bf974

iOS: mWeb Safari

https://github.com/Expensify/App/assets/117511920/d9ddd6e1-68cc-4b89-9898-45baa8c250a0

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/117511920/a7bebb88-8fc7-4b32-9b8b-856313fe0cd2

MacOS: Desktop

https://github.com/Expensify/App/assets/117511920/3cee2bb8-7026-46f8-84f3-b075d5756554

eh2077 avatar Apr 18 '24 07:04 eh2077

Nice!!! Thank you @eh2077 :D Now it's up to @tgolen, right?

brunovjk avatar Apr 18 '24 10:04 brunovjk

I can review this today, but there are a few conflicts currently. Can you please fix them before I review it? Thanks!

tgolen avatar Apr 18 '24 15:04 tgolen

Resolved the conflicts, let me test again.

brunovjk avatar Apr 18 '24 16:04 brunovjk

OK, the changes look fine to me. Let me know once you've run through a few tests and then I'll merge it.

tgolen avatar Apr 18 '24 17:04 tgolen

Good to go @tgolen :D

brunovjk avatar Apr 18 '24 17:04 brunovjk

Congrats, that’s your 5th PR merged! :tada: Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

melvin-bot[bot] avatar Apr 18 '24 18:04 melvin-bot[bot]

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.64-6 🚀

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

OSBotify avatar Apr 23 '24 23:04 OSBotify

@eh2077 @brunovjk, I think that while you were resolving conflicts, you mistakenly added back the dependencies that were removed in this PR. This issue is now again reproducible for tags.

Krishna2323 avatar Apr 26 '24 17:04 Krishna2323

Thanks, @Krishna2323, for catching that. My apologies for the reintroduced issue. I'm available to submit another PR if the team agrees. Do we only need to remove transaction and transactionID https://github.com/Expensify/App/blob/035adb890e559f287368b75f8cbe138c20e3f73a/src/components/MoneyRequestConfirmationList.tsx#L523 and add back "eslint-disable-next-line"?

brunovjk avatar Apr 26 '24 17:04 brunovjk

@brunovjk, I assume transactionID remains unchanged when transaction details are altered, so we can leave it as is. We only need to remove transaction, but please verify this while recording the videos to be certain. Thanks :)

Krishna2323 avatar Apr 26 '24 18:04 Krishna2323

@eh2077 @brunovjk, I think that while you were resolving conflicts, you mistakenly added back the dependencies that were removed in this PR. This issue is now again reproducible for tags.

@Krishna2323 Sorry, I can't reproduce https://github.com/Expensify/App/issues/38744 on production and staging anymore. I try both category and tag.

@brunovjk Can you reproduce that?

eh2077 avatar Apr 29 '24 12:04 eh2077

@eh2077 Actually not exactly like the OP of the issue. However, I can see some inconsistencies (different lag/delay time) when selecting and deselecting categories and tags. But absolutely nothing like the problem presented before.

brunovjk avatar Apr 29 '24 13:04 brunovjk