App icon indicating copy to clipboard operation
App copied to clipboard

[HOLD Web-E 44237] fix: distance - share with accountant

Open paultsimura opened this issue 1 year ago • 15 comments

Details

This PR is intended to fix several issues with the tracked distance expenses shared with accountants.

Fixed Issues

$ https://github.com/Expensify/App/issues/46897 PROPOSAL: https://github.com/Expensify/App/issues/46897#issuecomment-2418927514

Tests

Same as QA

Offline tests

Same as QA

QA Steps

Violation flow

  1. Create a workspace if needed
  2. Enable distance rates in settings from more features
  3. Add a custom rate
  4. Edit the default rate to a different value
  5. Open the chat with yourself
  6. Track a Distance expense
  7. In the Concierge prompt, click "Share it with my accountant"
  8. Select a workspace
  9. Verify there's an error on the rate field instructing you to choose a workspace rate
  10. Verify you can't submit the expense with the error present
  11. Select a workspace rate
  12. Verify the error clears
  13. Submit the expense
  14. Verify it's moved to the workspace
  15. Verify it uses with the proper rate and distance, and the receipt image is updated

Auto-select rate flow

  1. Open the chat with yourself
  2. Track a Distance expense
  3. Check the mileage rate automatically set on the request
  4. Create a workspace if needed
  5. Enable distance rates in settings from more features
  6. Add a custom rate with the exact same value as in the step 3
  7. Go back to the chat with yourself
  8. In the Concierge prompt, click "Share it with my accountant"
  9. Select a workspace
  10. Verify there is no error on the rate field
  11. Click the "Rate" field
  12. Verify the custom rate which you've added in step 6 is automatically marked as "Selected"
  13. Submit the expense
  14. Verify it's moved to the workspace
  15. Verify it uses with the proper rate and distance, and the receipt image is updated

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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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: https://expensify.slack.com/archives/C01GTK53T8Q/p1733422995256259?thread_ts=1732731519.995199&cid=C01GTK53T8Q
    • [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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • [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 form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label 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

https://github.com/user-attachments/assets/8ce7c4e7-bd72-44dc-b32b-fd06f6e09fde

Android: mWeb Chrome

https://github.com/user-attachments/assets/f6959411-83ab-4f5c-b7a6-8ccee49d7618

iOS: Native

https://github.com/user-attachments/assets/8cdf3000-b2f2-4d35-9fbe-e466bc6a83ba

iOS: mWeb Safari

https://github.com/user-attachments/assets/11180786-7967-4df0-8231-3df778cb7aad

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/fb842c03-a5da-4d4e-b2b7-bd7c99719107

MacOS: Desktop

https://github.com/user-attachments/assets/c2491a44-9e04-4f9e-b675-e38a1e8a2068

paultsimura avatar Oct 26 '24 06:10 paultsimura

Made some progress on the PR today.

paultsimura avatar Nov 11 '24 22:11 paultsimura

With the recent changes, seems like the flow works fine (please see the recordings). Still need the "Moved expense" copy though.

paultsimura avatar Nov 13 '24 16:11 paultsimura

@Pujan92 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 Nov 15 '24 11:11 melvin-bot[bot]

@Pujan92 I believe only the copy is pending here, therefore you can start testing the flow.

paultsimura avatar Nov 15 '24 11:11 paultsimura

I asked for a copy check on the issue

neil-marcellini avatar Nov 20 '24 21:11 neil-marcellini

@neil-marcellini since we went live with the P2P distance requests, will there be any cleanup for the canUseP2PDistanceRequests usages?

paultsimura avatar Nov 22 '24 16:11 paultsimura

@neil-marcellini for the in-existing rate, would this format work (message TBD)?

image

When incorrect route is selected, we don't show the field error, but a form error at the bottom. I'm wondering if we should keep this behavior consistent (I just added the RBR for better clarity of which field is faulty):

image

paultsimura avatar Nov 22 '24 16:11 paultsimura

@neil-marcellini since we went live with the P2P distance requests, will there be any cleanup for the canUseP2PDistanceRequests usages?

I already removed all of them on main, so please make sure that's removed here too.

neil-marcellini avatar Nov 22 '24 17:11 neil-marcellini

@paultsimura I like what you did there with the RBR on the field and the form error message at the bottom. If you want, you could also do that for the route error, or tackled that in a separate PR.

neil-marcellini avatar Nov 22 '24 17:11 neil-marcellini

Got a bit stuck on the PR – asked a couple of clarifying questions here.

paultsimura avatar Nov 28 '24 22:11 paultsimura

@neil-marcellini @Pujan92 the PR is almost ready. However, I have an issue with the dependency cycle.

We've agreed on using the root level report name in the MODIFIEDEXPENSE message: moved expense from self DM to chat with {username} or moved expense from self DM to {workspace name}.

I'd like to reuse the ReportUtils.getReportName function inside the ModifiedExpenseMessage.getForReportAction, but ReportUtils.getReportName uses ModifiedExpenseMessage.getForReportAction in one specific case:

https://github.com/Expensify/App/blob/c049ac7ec616db1d936c021b08b17a35eb418fd3/src/libs/ReportUtils.ts#L4015-L4018

What would be your suggestion to avoid this cycle? It's nearly impossible to decouple the ReportUtils.getReportName as it uses a lot of the utilitary functions, such as isGroupChat, isPolicyExpenseChat, etc.

I could potentially move all of these functions into separate files and export them all from ReportUtils/index.ts, but it will create a dozen of one-file functions.

Or I could force allow the dependency cycle.

But maybe you could suggest a more elegant approach.

paultsimura avatar Dec 05 '24 10:12 paultsimura

I ended up splitting ReportUtils.getReportName and allowing the indirect dependency cycle. It should be resolved after https://expensify.slack.com/archives/C01GTK53T8Q/p1733492380567339.

paultsimura avatar Dec 06 '24 16:12 paultsimura

Ready for your review @Pujan92.

paultsimura avatar Dec 06 '24 17:12 paultsimura

The Web-E PR is on staging now so you should be able to fully test it. I'll remove HOLD once it's on prod, which should happen on Monday.

neil-marcellini avatar Dec 06 '24 17:12 neil-marcellini

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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

https://github.com/user-attachments/assets/ba33f1ac-0b39-449a-9546-f5928d28cfdd

MacOS: Desktop

Pujan92 avatar Dec 09 '24 12:12 Pujan92

Only issue I am seeing is that there is some distance unit(km and ml) inconsistency after the rate selection and with the price in the preview.

https://github.com/user-attachments/assets/c180ad6d-1c29-45ea-81da-f1611a353139

Pujan92 avatar Dec 10 '24 18:12 Pujan92

Only issue I am seeing is that there is some distance unit(km and ml) inconsistency after the rate selection and with the price in the preview.

https://github.com/user-attachments/assets/c180ad6d-1c29-45ea-81da-f1611a353139

I saw that too, but it should be out of scope here

paultsimura avatar Dec 10 '24 18:12 paultsimura

@paultsimura can you please explain why the bug with the unit inconsistency should be out of scope? It seems like something we can and should fix as part of this flow.

neil-marcellini avatar Dec 11 '24 17:12 neil-marcellini

@paultsimura can you please explain why the bug with the unit inconsistency should be out of scope? It seems like something we can and should fix as part of this flow.

Because it is something that already exists in prod (so not caused by my changes) and is not described in the initial issue steps and expectations. Also, the nature of the bug is different from the one we are resolving now, although it's also related to the "share expense" flow.

If we want to fix this as well, I would like to request bounty bump to $500 as it is a good chunk of extra work — we've already expanded the scope on this PR compared to the accepted proposal.

paultsimura avatar Dec 11 '24 19:12 paultsimura

:hand: 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 avatar Dec 11 '24 22:12 OSBotify

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.75-0 🚀

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

github-actions[bot] avatar Dec 12 '24 01:12 github-actions[bot]

@paultsimura QA team faund issue https://github.com/Expensify/App/issues/53988 when validation this PR

https://platform.applause.com/services/links/v1/external/07fed6d6849dcbd2b4edb695dce1fc38808aad5a2d21e3ea58e4b987c6878c11

izarutskaya avatar Dec 12 '24 09:12 izarutskaya

@paultsimura QA team found issue #53988 when validation this PR

Thanks @izarutskaya, we've already established that it's only been revealed by this PR, not caused by it.

paultsimura avatar Dec 12 '24 09:12 paultsimura

Hey @paultsimura @Pujan92 @neil-marcellini. We have a blocker that might be related to these distance changes. Users are now unable to change distance rate because backend is not receiving the required customUnit.name data. Which seems possibly related to these changes.

If you could take a quick look that would be very helpful.

Julesssss avatar Dec 12 '24 11:12 Julesssss

That issue indeed seems to be caused by this PR, although it looks BE to me. I replied in your GH, let's keep the conversation there for clarity.

paultsimura avatar Dec 12 '24 11:12 paultsimura

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.75-6 🚀

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

github-actions[bot] avatar Dec 13 '24 15:12 github-actions[bot]