[Wave Collect][Xero] Import tracking categories

mananjadhav commented 2 weeks ago

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/39732 PROPOSAL:

Tests

Pre-requisite:

Xero account setup in an existing workspace.
You need to have 2 tracking categories named "Region" and "Cost centers", to set their mapping.
On your Xero account, select the Demo company organization.
Go to Accounting > Advanced, select "Tracking categories".
You should see something named "Region", in reality it can be any name that's why you must show/hide the option depending on the name of the tracking category.
Add a new tracking category named "Cost centers".

https://github.com/Expensify/App/assets/3069065/48094376-10db-4e18-b4fa-586d0a4ee134

Steps

Login with a user who already has the Xero account setup.
Go to Workspace having Xero connection -> Accounting -> Import.
Click on Tracking Categories
Verify that you're able to see Import toggle switch.
If the import toggle is off, then you shouldn't see any other option in the page.
Switch the Import to On, in the data you can verify that policy_<policyID>.connections.xero.config.importTrackingCategories is set to true. On switching off, it is set to false.
Once turned on you should see two items Map Xero cost centers to and Map Xero regions to.
Click on each of the menu items and perform the following steps: a. You should see the title of the page as the Map Xero <fieldname> to. b. You should see two options Xero contact default and Tags as two menu items. c. On selecting any one of the options, you should be redirected back to the tracking categories page, and the selected option should show up against each field title. d. In policy_<policyID>.connections.xero.mappings.trackingCategory_<trackingCategoryId> you should see the selected value , ie, DEFAULT for Xero contact default and TAG for Tags. e. The trackingCategoryId should be based on the id field of policy_<policyID>.connections.xero.trackingCategories.name matched to cost centers and regions respectively.

For all the data verification related info, go to Chrom Dev Tools -> Application -> Storage -> OnyxDB -> Search for your policy_. Check out the data in the connections object as shown in the screenshot below.

[x] 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

[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:
- [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

https://github.com/Expensify/App/assets/3069065/bc492e12-81d7-4662-ab37-602b690fd9d5

Android: mWeb Chrome

https://github.com/Expensify/App/assets/3069065/a34a23fd-fd59-48cb-8fb3-28e257b015bf

iOS: Native

https://github.com/Expensify/App/assets/3069065/104b5d0b-bda5-449e-adaa-57f088a07e44

iOS: mWeb Safari

https://github.com/Expensify/App/assets/3069065/51a1aa66-97e3-4803-ba41-620924d35b6d

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/3069065/ea3dd2f9-3147-4921-b0ff-d748c80bb12e

MacOS: Desktop

https://github.com/Expensify/App/assets/3069065/28197ed0-3d81-40d0-ace1-12e36ba1caac

mananjadhav commented 1 week ago

On Hold for https://github.com/Expensify/App/pull/41561. Waiting for ConnectionLayout padding fix to get merged so that I can create the screencasts for the mapping screens.

melvin-bot[bot] commented 1 week ago

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

mananjadhav commented 1 week ago

@Expensify/design For your review.

rushatgabhane commented 1 week ago

@mananjadhav i can't see cost center and region

mananjadhav commented 1 week ago

@rushatgabhane Did you check the pre-requisite in the Test steps? and did you try to select the Demo company ?

Pre-requisite:

Xero account setup in an existing workspace.

You need to have 2 tracking categories named "Region" and "Cost centers", to set their mapping.

On your Xero account, select the Demo company organization.

Go to Accounting > Advanced, select "Tracking categories".

You should see something named "Region", in reality it can be any name that's why you must show/hide the option depending on the name of the tracking category.

Add a new tracking category named "Cost centers".

lakchote commented 1 week ago

@mananjadhav i can't see cost center and region

To follow up with @mananjadhav, please see this discussion for context on how to enable them.

mananjadhav commented 1 week ago

@lakchote I didn't understand what you meant? The link also doesn't take me to any specific thread. I already added the pre-requisite on how to add them based on your instructions in slack. Is there anything else that's expected from me?

shawnborton commented 1 week ago

Design-wise this looks good to me.

mananjadhav commented 1 week ago

This is because the category options are hardcoded to Tags and Default. But I selected Report Field

Got it. We'll be adding this in future. But at the moment I think it should show blank here then? @trjExpensify @lakchote ?

rushatgabhane commented 1 week ago

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

https://github.com/Expensify/App/assets/29673073/a29cbc4f-ae61-42d4-b3d2-021428080824

iOS: mWeb Safari

https://github.com/Expensify/App/assets/29673073/18ce3882-fe6a-4f51-9989-52745e968bb2

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/29673073/fd061085-fcf1-4919-9d1a-8ccc1c2224c3

MacOS: Desktop

lakchote commented 1 week ago

@lakchote I didn't understand what you meant? The link also doesn't take me to any specific thread. I already added the pre-requisite on how to add them based on your instructions in slack. Is there anything else that's expected from me?

It was meant for @rushatgabhane to help him enable mapping options.

This is because the category options are hardcoded to Tags and Default. But I selected Report Field

Got it. We'll be adding this in future. But at the moment I think it should show blank here then? @trjExpensify @lakchote ?

Report field will be added once we'll port Control workspaces to NewDot. It's a Control feature.

I'd move in favour of showing blank there in the meantime.

mananjadhav commented 1 week ago

Thanks for the comment @lakchote. I'll push an update in a while for the Report field.

mananjadhav commented 1 week ago

@rushatgabhane @lakchote Added a fix to show blank for the report field. I didn't refactor too much because we are anyway going remove it later.

OSBotify commented 1 week ago

: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.

lakchote commented 1 week ago

I have merged by mistake (since we're on merge freeze). Since it's behind beta, and it should not influence any user behaviour we don't need to revert it.

I've created a new xero-merge-freeze branch for the next Xero PRs, people will need to use it as a base instead of main in the meantime to not block progress.

OSBotify commented 1 week ago

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

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

lanitochka17 commented 1 week ago

Tell us about PR Pre-props: step 4 cannot be completed because we do not see "Tracking categories" Go to Accounting > Advanced, select Tracking Categories. How do we set up an account to complete these steps? thank you in advance

https://github.com/Expensify/App/assets/78819774/4d56ce08-77d3-4a7d-b3fb-1de2ec19d8b4

mananjadhav commented 1 week ago

@lanitochka17 Did you try the steps mentioned in the pre-requisites? Please find attached video on navigating through Xero. You should see Demo Company when you create a new account on Xero, and use that for syncing when you test it.

https://github.com/Expensify/App/assets/3069065/48094376-10db-4e18-b4fa-586d0a4ee134

m-natarajan commented 1 week ago

@mananjadhav Thanks for sharing the video again. I have a question, How to verify the PR step 6 and 8.d and e? Is this can only be done internally?

mananjadhav commented 1 week ago

You should be able to view this in the application data onyxdb in Chrom Dev tools. I've added a note in the steps along with the screenshot.

OSBotify commented 5 days ago

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.72-1 🚀

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

Expensify / App