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

[QBO Export] Manual exports #44170

Conversation

kosmydel
Copy link
Contributor

@kosmydel kosmydel commented Jun 21, 2024

Details

This PR:

  • Add new exportToIntegration and markAsManuallyExported actions
  • Add a new Export menu item to the report details page
  • Create a new ReportDetailsExportPage with "Export" and "Mark as exported" options
  • Update ReportPreview actions to show export options
  • Update the MoneyReportHeader to show export options

Fixed Issues

$ #44022
PROPOSAL: N/A

Tests

Those tests should be performed on the staging environment. In your .env file add ENVIRONMENT=staging variable.

Do the tests below for both QBO and Xero integrations.

Prerequisites

  1. Collect workspace with an admin and member
  2. Setup QBO integration connection

Steps 1

  1. Open the report details (click the carret in the header) on the failed report
  2. Verify there’s an “Export” Item
  3. Select it
  4. Verify there’s a “Mark as manually entered” option and select it
  5. Verify
  6. A system message “marked this report as manually exported to QuickBooks Online” is added to the report
  7. The red dot on the report in the LHN is removed
  8. Click on the "Export" item and "Mark as manually entered" again, verify the "reports have already been exported" modal is displayed.
    Steps 2
  9. Turn off auto sync in Workspace -> Accountting -> Advanced
  10. Create a new expense in the policy
  11. Pay expense elsewhere
  12. A Export button should appear in the report preview and report header.
  13. Click on the "Export" button in the report preview
  14. Verify everything works.

Offline tests

Offline pattern B is going to be implemented in a follow-up PR here.

QA Steps

  • Verify that no errors appear in the JS console
  • Do the tests from the Tests section above

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.mov
Android: mWeb Chrome
mweb-android.mov
iOS: Native
ios.mp4
iOS: mWeb Safari
mweb-ios.mp4
MacOS: Chrome / Safari
web1.mov
web2.mov
MacOS: Desktop
desktop.mov

@kosmydel
Copy link
Contributor Author

Hey @Expensify/design, could you please share the "Not ready to export" illustration with me? Thank you!

Screenshot 2024-06-25 at 13 26 11

@hungvu193
Copy link
Contributor

hungvu193 commented Jun 26, 2024

@kosmydel it looks the same with the image we used in SageIntacct feature. In that case you can take in from here:
https://github.com/Expensify/App/pull/43661/files#diff-e81b59ee3960feb94e1b55384682e24b2fcece6d7fd90ad2e6a98fa5f31de532

Screenshot 2024-06-26 at 09 28 52

@hungvu193
Copy link
Contributor

Oops my bad, it looks different 🤦

@dannymcclain
Copy link
Contributor

@kosmydel Here's that illustration!

LaptopwithSecondScreenandHourglass.svg.zip

Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

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

Great work so far just a few changes needed

src/libs/actions/Report.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/pages/home/report/ReportDetailsExportPage.tsx Outdated Show resolved Hide resolved
@kosmydel
Copy link
Contributor Author

I've addressed the review, ready for re-review.

@arosiclair
Copy link
Contributor

Thanks for the changes!

@arosiclair
Copy link
Contributor

Hm actually looking at @hungvu193's screenshots, why doesn't "Quickbooks Online" show in the message text here? It looks like it's missing on all platforms

@hungvu193
Copy link
Contributor

Hm actually looking at @hungvu193's screenshots, why doesn't "Quickbooks Online" show in the message text here? It looks like it's missing on all platforms

Yeah, I think BE related, here's the return values from OpenReport, probably related to #44170 (comment) .
Screenshot 2024-07-16 at 22 41 10

@arosiclair
Copy link
Contributor

That's weird, but agree it shouldn't be an issue with this PR. Merging!

@arosiclair arosiclair merged commit 303c398 into Expensify:main Jul 16, 2024
15 checks passed
@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/arosiclair in version: 9.0.8-1 🚀

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

@kavimuru
Copy link

@kosmydel @hungvu193 @arosiclair how to make a failed report as in the step 1

Open the report details (click the carret in the header) on the failed report

@hungvu193
Copy link
Contributor

hungvu193 commented Jul 17, 2024

@kosmydel @hungvu193 @arosiclair how to make a failed report as in the step 1

Open the report details (click the carret in the header) on the failed report

IIRC You neeed to export it first

@arosiclair
Copy link
Contributor

@kosmydel @hungvu193 @arosiclair how to make a failed report as in the step 1

@kavimuru here are steps to force an export to QBO to fail:

Prerequisites

Add a chart of account (category) to QBO that you can delete later

Steps

  1. Create a report with an expense
  2. Categorize the expense using the new QBO category
  3. Submit it
  4. Log in as the workspace admin and approve the report
  5. Log into QBO and deactivate the chart of account for the category (Menu > Transactions > Chart of accounts > {account} menu > Make inactive)
  6. Export the report to QBO (3-dot menu > Export > Quickbooks Online)
  7. Verify
    • a system message “failed to auto-export this report due to an error” is added to the report
    • a red dot is added next to the report in the LHN

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/Beamanator in version: 9.0.8-3 🚀

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

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

@OSBotify
Copy link
Contributor

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

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

@hungvu193 hungvu193 mentioned this pull request Jul 18, 2024
50 tasks
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.9-5 🚀

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

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.