Add report fields to QBO/Xero by lakchote · Pull Request #51321 · Expensify/App

lakchote · 2024-10-23T10:12:05Z

Details

We need to add the report fields option for QBO/Xero to close our product gap between OldDot and NewDot.

Fixed Issues

$ #51320

Tests

Verify that no errors appear in the JS console

Did the tests outlined in the document here

QBO

qbo.mov

Xero

xero.mov

Offline tests

Offline tests are outlined in the document in the section above.

QA Steps

Verify that no errors appear in the JS console

Same as in tests

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 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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.
I verified that similar component doesn't exist in the codebase
I verified that all props are defined accurately and each prop has a /** comment above it */
I verified that each file is named correctly
I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
I verified that the only data being stored in component state is data necessary for rendering and nothing else
In component 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)
I verified that component 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)
I verified that all JSX used for rendering exists in the render method
I verified that each 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
I verified that similar component doesn't exist in the codebase
I verified that all props are defined accurately and each prop has a /** comment above it */
I verified that each file is named correctly
I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
I verified that the only data being stored in component state is data necessary for rendering and nothing else
In component 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)
I verified that component 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)
I verified that all JSX used for rendering exists in the render method
I verified that each 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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-10-23T12:17:07Z

@aimane-chnaif 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]

lakchote · 2024-10-23T12:19:49Z

@aimane-chnaif I've shared with you the design doc in case you need more context.

lakchote · 2024-10-24T12:15:47Z

@allgandalf could you please retest?

Video for bug #1 fix:

Screen.Recording.2024-10-24.at.14.16.27.mov

Video for bug #2 fix:

Screen.Recording.2024-10-24.at.14.17.29.mov

allgandalf · 2024-10-24T12:20:52Z

Bug, we do not disable the option to click on the list page for QBO locations:

Screen.Recording.2024-10-24.at.5.50.14.PM.mov

allgandalf · 2024-10-24T12:21:22Z

Also test is failing

allgandalf · 2024-10-24T12:42:02Z

Not a blocker but if you change export as from credit card to debit card and go to the list page there we still see as Tags it only updates to Report Fields when we open the location settings:

Screen.Recording.2024-10-24.at.6.11.13.PM.mov

allgandalf · 2024-10-24T12:57:33Z

Lint failure :/

allgandalf

Going out for dinner, this tests well now, let's hope the pending reassurance test passes.
We are good to merge this 👍 , I verified the following according to the testing doc:

Manual Test

Pre-testing steps

Make sure that your test account is on the accountingOnNewExpensify beta (Doesn't require beta to test)
Make sure you have QBO and Xero credentials to initiate a connection
Make sure you create a new workspace/policy for each test run
Make sure emails sent to the testing email addresses go to an inbox you can access to validate your account(s) (Internal)

QuickBooks Online

Classes

Verify that the Displayed As option appears below the toggle.
Verify that a new page opens with options to select Tags or Report Fields.
Verify that the selection is saved, and you're navigated back to the Classes configuration page.

Customers/Projects

Verify that the Displayed As option appears below the toggle.
Verify that options to select Tags or Report Fields are displayed.
Verify that the selection is saved, and you return to the configuration page.

Locations

Verify there’s no explanatory subtext under Import menu item
Verify that the Displayed As option appears below the toggle and there’s no right icon.
Verify there is an explanatory subtext like here
Verify that you see Check, Journal entry, Vendor bill as the available options.
Verify you don’t see the explanatory subtext anymore and that you see the right icon for `Displayed as
Verify that options to select Tags or Report Fields are displayed.
Verify that the selection is saved, and you return to the configuration page.
Verify that the Report Fields option has been correctly persisted after refreshing the page
Verify that you only see Journal entry, as the available option.

Xero

Tracking Categories

Verify that the Displayed As option appears below the toggle.
Verify that options to select Tags or Report Fields are displayed.
Verify that the selection is saved, and you return to the configuration page.

melvin-bot · 2024-10-24T13:12:43Z

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

lakchote · 2024-10-24T13:13:48Z

Thank you @allgandalf 🙏

robertjchen

LGTM!

robertjchen · 2024-10-25T08:15:40Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 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(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.
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

MacOS: Desktop

OSBotify · 2024-10-25T08:27:49Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-10-25T21:18:57Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/51321/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/51321/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/51321/NewExpensify.dmg	https://51321.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

github-actions · 2024-10-29T09:44:52Z

🚀 Deployed to staging by https://github.com/lakchote in version: 9.0.55-0 🚀

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

github-actions · 2024-10-31T11:18:10Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.55-10 🚀

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

eh2077 · 2024-12-03T12:54:46Z

src/pages/workspace/accounting/qbo/import/QuickbooksCustomersDisplayedAsPage.tsx

+    const selectDisplayedAs = useCallback(
+        (row: CardListItem) => {
+            if (row.value !== qboConfig?.syncCustomers) {
+                QuickbooksOnline.updateQuickbooksOnlineSyncCustomers(policyID, row.value, qboConfig?.syncCustomers);


Since Report Fields are a Control feature, we should be showing the Report Fields upgrade RHN. This was caught by #52397

lakchote added 15 commits October 23, 2024 11:55

add QBO routes for report fields selection

d4da88c

add QBO screens for report fields selection

5e7380d

define types for new QBO screens

4dd4829

link the new QBO screens to relative routes

5c7cc28

link new QBO screens to corresponding components

a63bc1d

add new QBO screens

069884c

adjust translations for QBO report fields

63e4a53

allow locations for vendor bills and checks

ccf7da4

link to new QUICKBOOKS_ONLINE_CLASSES_DISPLAYED_AS route

29ce003

component for QUICKBOOKS_ONLINE_CLASSES_DISPLAYED_AS route

064c4cc

link to new QUICKBOOKS_ONLINE_CUSTOMERS_DISPLAYED_AS route

6f1fadf

component for QUICKBOOKS_ONLINE_CUSTOMERS_DISPLAYED_AS route

f3a3430

link to new QUICKBOOKS_ONLINE_LOCATIONS_DISPLAYED_AS route

9eea23d

component for QUICKBOOKS_ONLINE_LOCATIONS_DISPLAYED_AS route

6bd6a67

add report field option for Xero tracking categories

67c8941

lakchote self-assigned this Oct 23, 2024

lakchote added 7 commits October 23, 2024 12:17

fix style

4a5350c

fix translation keys

2e33bff

adjust for fixed translation keys

f93a540

fix lint

bbf3ea9

fix style

68a6b8b

fix lint

bd6c9fe

fix lint

e50f050

lakchote marked this pull request as ready for review October 23, 2024 12:17

lakchote requested a review from a team as a code owner October 23, 2024 12:17

melvin-bot bot requested review from aimane-chnaif and removed request for a team October 23, 2024 12:17

lakchote removed the request for review from aimane-chnaif October 24, 2024 10:45

fix logic

a7772ad

lakchote added 3 commits October 24, 2024 14:22

fix lint

a8a3862

address comments and handle invalid configuration

12dd284

fix lint

2dc2dfa

lakchote added 3 commits October 24, 2024 14:54

create utility file for QBO

a7ee8fb

use utils

661dbb1

handle locations with incorrect configuration

4f1e768

lakchote added 2 commits October 24, 2024 14:58

fix lint

63e6290

fix style

a391854

allgandalf approved these changes Oct 24, 2024

View reviewed changes

melvin-bot bot requested a review from Gonals October 24, 2024 13:12

robertjchen approved these changes Oct 25, 2024

View reviewed changes

lakchote merged commit a86ee35 into main Oct 25, 2024

lakchote deleted the lucien/qbo-xero-report-fields branch October 25, 2024 08:16

lakchote added the Ready To Build label Oct 25, 2024

github-actions bot mentioned this pull request Oct 29, 2024

Deploy Checklist: New Expensify 2024-10-29 #51635

Closed

65 tasks

melvin-bot bot mentioned this pull request Oct 31, 2024

[HOLD for payment 2024-11-07] Add report fields to QBO/Xero #51320

Closed

eh2077 reviewed Dec 3, 2024

View reviewed changes

Conversation

lakchote commented Oct 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 23, 2024

Uh oh!

lakchote commented Oct 23, 2024

Uh oh!

lakchote commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

allgandalf commented Oct 24, 2024

Uh oh!

allgandalf commented Oct 24, 2024

Uh oh!

allgandalf commented Oct 24, 2024

Uh oh!

allgandalf commented Oct 24, 2024

Uh oh!

allgandalf left a comment

Choose a reason for hiding this comment

Manual Test

Pre-testing steps

QuickBooks Online

Classes

Customers/Projects

Locations

Xero

Tracking Categories

Uh oh!

melvin-bot bot commented Oct 24, 2024

Uh oh!

lakchote commented Oct 24, 2024

Uh oh!

robertjchen left a comment

Choose a reason for hiding this comment

Uh oh!

robertjchen commented Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Oct 25, 2024

Uh oh!

github-actions bot commented Oct 25, 2024

Uh oh!

github-actions bot commented Oct 29, 2024

Uh oh!

github-actions bot commented Oct 31, 2024

Uh oh!

eh2077 Dec 3, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lakchote commented Oct 23, 2024 •

edited

Loading

lakchote commented Oct 24, 2024 •

edited

Loading

robertjchen commented Oct 25, 2024 •

edited

Loading