Display error messages for Xero Import page #41917

SzymczakJ · 2024-05-09T14:03:14Z

Details

This PR adds error messages for Xero Import page.

Fixed Issues

$ #41843
PROPOSAL: N/A

Tests

With a Workspace with a Xero connection
Turn on offline mode on troubleshoot page
Go to Import page
Turn on/off some of the import page items
Verify that the XeroImportPage looks like this(there's fade on changed items):

Go into one of the XeroImportPage subpages that got changed and Verify that it looks like this:

Turn on simulate failing network requests on troubleshoot page and turn off offline mode
Go to Import page and turn on/off some of the import page items
Verify that the XeroImportPage looks like this(there's red brick road indicator):

Go into one of the XeroImportPage subpages that got changed and Verify that it looks like this:

Offline tests

QA Steps

Same as 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 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

androidweb.mov

iOS: Native

https://github.com/Expensify/App/assets/88395093/8d1066f0-b09d-46c6-99ea-98d698018efa

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

lakchote · 2024-05-09T15:24:24Z

@Expensify/design could you please review these error messages if they look good to you?

shawnborton · 2024-05-09T15:54:47Z

Before we merge this, should we wait until @narefyev91's PR here is merged? That will give us the updated error style that we want.

lakchote · 2024-05-09T15:57:39Z

@trjExpensify this PR will add error messages to the main Import page.

@SzymczakJ asked me if we should add error messages to the sub page of the Import page also?
It'd look like this below:

Could we have your opinion on this?

shawnborton · 2024-05-09T16:24:07Z

That error style seems way off btw - if we do go with an error on this page, it should stretch to the full width of that view and sit underneath the toggle row:

trjExpensify · 2024-05-10T01:02:06Z

@SzymczakJ asked me if we should add error messages to the sub page of the Import page also?
It'd look like this below:

I think there's typically only one place the error message is and that's at the end of the brick road. So if that's on the Tracking Categories page because of a problem with the import toggle, it should only be there. The "red dots" of the red brick road lead to it.

SzymczakJ · 2024-05-10T10:08:27Z

@trjExpensify so you suggest that we shouldn't show error messages on Xero Import Page and instead of that show error messages on Import Page subpages(and show only red dot on Import page).
It would look something like that:

cc @trjExpensify @lakchote @shawnborton

trjExpensify · 2024-05-10T10:52:23Z

@trjExpensify so you suggest that we shouldn't show error messages on Xero Import Page and instead of that show error messages on Import Page subpages(and show only red dot on Import page). It would look something like that:

cc @trjExpensify @lakchote @shawnborton

Yes exactly, because the end of the red brick road is one page deeper and the end of the road is where the error message appears. 👍

SzymczakJ · 2024-05-13T15:24:00Z

I've addressed your review comments @Expensify/design, could you please review this? 🙏
Current version of screens is in the test steps
cc @shawnborton @trjExpensify

shawnborton · 2024-05-13T15:25:13Z

Cool, I think that feels pretty good to me.

filip-solecki · 2024-05-14T07:40:17Z

src/pages/workspace/accounting/xero/XeroTaxesConfigurationPage.tsx

 import CONST from '@src/CONST';

 function XeroTaxesConfigurationPage({policy}: WithPolicyProps) {
 const {translate} = useLocalize();
 const styles = useThemeStyles();
 const policyID = policy?.id ?? '';
- const {importTaxRates, pendingFields} = policy?.connections?.xero?.config ?? {};
+ const xeroConfig = policy?.connections?.xero?.config;


Suggested change

const xeroConfig = policy?.connections?.xero?.config;

const xeroConfig = policy?.connections?.xero?.config ?? {};

And you don't have to add empty object in each place later

src/pages/workspace/accounting/xero/XeroTaxesConfigurationPage.tsx

filip-solecki · 2024-05-14T07:41:45Z

src/pages/workspace/accounting/xero/XeroTrackingCategoryConfigurationPage.tsx

+ <ToggleSettingOptionRow
+ title={translate('workspace.accounting.import')}
+ switchAccessibilityLabel={translate('workspace.xero.trackingCategories')}
+ isActive={!!isSwitchOn}


There is no need to use !! as it is Booelan already

filip-solecki · 2024-05-14T07:41:54Z

src/pages/workspace/accounting/xero/XeroTrackingCategoryConfigurationPage.tsx

+ const xeroConfig = policy?.connections?.xero?.config;
+ const {importTrackingCategories} = policy?.connections?.xero?.config ?? {};
+
+ const isSwitchOn = Boolean(importTrackingCategories);


Suggested change

const isSwitchOn = Boolean(importTrackingCategories);

const isSwitchOn = !!importTrackingCategories;

filip-solecki · 2024-05-14T07:42:06Z

src/pages/workspace/accounting/xero/XeroTrackingCategoryConfigurationPage.tsx

@@ -22,7 +21,10 @@ function XeroTrackingCategoryConfigurationPage({policy}: WithPolicyProps) {
 const {translate} = useLocalize();
 const styles = useThemeStyles();
 const policyID = policy?.id ?? '';
- const {importTrackingCategories, pendingFields} = policy?.connections?.xero?.config ?? {};
+ const xeroConfig = policy?.connections?.xero?.config;


same suggestion as above

filip-solecki · 2024-05-14T07:42:34Z

src/pages/workspace/accounting/xero/import/XeroCustomerConfigurationPage.tsx

+ wrapperStyle={styles.sectionMenuItemTopDescription}
+ />
+ }
+ isActive={!!isSwitchOn}


same as above

filip-solecki · 2024-05-14T07:43:53Z

src/pages/workspace/categories/WorkspaceCategoriesSettingsPage.tsx

@@ -23,6 +23,7 @@ function WorkspaceCategoriesSettingsPage({policy, route}: WorkspaceCategoriesSet
 const isConnectedToAccounting = Object.keys(policy?.connections ?? {}).length > 0;
 const policyID = route.params.policyID ?? '';
 const [policyCategories] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyID}`);
+ const toggleSubtitle = isConnectedToAccounting ? `${translate('workspace.categories.needCategoryForExportToIntegration')} ${translate('workspace.accounting.qbo')}` : '';


is it correct? We check here for any connection(may be xero) and display qbo text

melvin-bot · 2024-05-14T09:34:33Z

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

filip-solecki

LGTM

fedirjh · 2024-05-15T03:14:12Z

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

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-05-15.at.03.51.14.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-05-15T08:12:32Z

✋ 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 · 2024-05-15T10:15:17Z

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

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

Julesssss · 2024-05-16T11:00:51Z

FYI, a bug was raised where the RBR error isn't always displayed. As this is a new feature I'm not marking it as a blocker though.

hayata-suenaga · 2024-05-16T16:28:56Z

src/pages/workspace/categories/WorkspaceCategoriesSettingsPage.tsx

@@ -44,7 +53,9 @@ function WorkspaceCategoriesSettingsPage({policy, route}: WorkspaceCategoriesSet
 <View style={styles.flexGrow1}>
 <ToggleSettingOptionRow
 title={translate('workspace.categories.requiresCategory')}
- subtitle={isConnectedToAccounting ? `${translate('workspace.categories.needCategoryForExportToIntegration')} ${translate('workspace.accounting.qbo')}` : ''}
+ titleStyle={styles.textStrong}


The text in the ToggleSettingOptionRow shouldn't be bold. 🙇

hayata-suenaga · 2024-05-16T16:52:40Z

@SzymczakJ, thank you for the PR 🙇

I have a question about a change you made in this PR:

I realized that you introduced a new prop to ToggleSettingOptionRow called titleStyle. I also see that you used this prop to pass textStrong style object to several places.

This seems to have caused several texts becoming bold when they're not supposed to. I was wondering if there was a reason that you made this design change? 😄

OSBotify · 2024-05-23T00:00:18Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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

SzymczakJ · 2024-05-23T16:11:59Z

@hayata-suenaga sorry for missing your message and causing design regressions 😅. I didn't mean to change anything in designs, I just wanted to refactor the <ToggleSettingOptionRow />.
<ToggleSettingOptionRow /> was actually adding bold style with styles.textMicroBold when shouldPlaceSubtitleBelowSwitch was false or undefined. I didn't want the <ToggleSettingOptionRow /> titleText style to be dependent on shouldPlaceSubtitleBelowSwitch(which was causing me some trouble). I made <ToggleSettingOptionRow /> accept the titleStyle prop and passed styles.textStrong when the styles.textMicroBold would be applied before(because these were the only styles that were missing after deleting styles.textMicroBold).
tl:dr I think the bold text was there before my PR got merged, but correct me if I'm wrong 🙇

hayata-suenaga · 2024-05-23T17:57:52Z

tl:dr I think the bold text was there before my PR got merged, but correct me if I'm wrong 🙇

that's fair I think the timing of removing the bold style and this PR probably coincided 😅 Anyway, thank you for your work @SzymczakJ!

display error message on XeroImport

2684a5d

SzymczakJ changed the base branch from main to xero-merge-freeze May 9, 2024 14:54

SzymczakJ force-pushed the @szymczak/error-messages-xero-import branch from a86b6fb to 2684a5d Compare May 10, 2024 14:36

lakchote mentioned this pull request May 13, 2024

[Wave Collect][Xero] Display error messages for Xero Import page #41843

Closed

SzymczakJ added 3 commits May 13, 2024 16:16

refactor ToggleSettingOptionRow

87d28ef

add error/offline state to Import subpages

c2f3ad9

delete pending action on XeroImportPage subviews

a6dad75

SzymczakJ changed the base branch from xero-merge-freeze to main May 13, 2024 14:51

Merge branch 'main' into @szymczak/error-messages-xero-import

814e016

fix lint

9e0df9c

filip-solecki reviewed May 14, 2024

View reviewed changes

SzymczakJ added 5 commits May 14, 2024 09:58

Merge branch 'main' into @szymczak/error-messages-xero-import

73614fb

fix PR comments

44c69ae

Merge branch 'main' into @szymczak/error-messages-xero-import

e0e839c

fix typecheck

ef10ca8

Merge branch 'main' into @szymczak/error-messages-xero-import

cc5ec33

SzymczakJ marked this pull request as ready for review May 14, 2024 09:33

SzymczakJ requested a review from a team as a code owner May 14, 2024 09:33

melvin-bot bot requested review from fedirjh and removed request for a team May 14, 2024 09:34

filip-solecki approved these changes May 14, 2024

View reviewed changes

delete pending action from XeroChartOfAccountsPage

9ebd3ab

fedirjh approved these changes May 15, 2024

View reviewed changes

melvin-bot bot requested a review from lakchote May 15, 2024 03:16

lakchote approved these changes May 15, 2024

View reviewed changes

lakchote merged commit 8e76163 into Expensify:main May 15, 2024
17 checks passed

github-actions bot mentioned this pull request May 15, 2024

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

m-natarajan mentioned this pull request May 16, 2024

[Xero] Import page error message RBR isn't always displayed #42268

Closed

6 tasks

hayata-suenaga reviewed May 16, 2024

View reviewed changes

hayata-suenaga mentioned this pull request May 16, 2024

[HOLD for payment 2024-06-06] [QBO] Fix style regression for the text in ToggleSettingOptionRow #42309

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display error messages for Xero Import page #41917

Display error messages for Xero Import page #41917

SzymczakJ commented May 9, 2024 •

edited

Loading

lakchote commented May 9, 2024

shawnborton commented May 9, 2024

lakchote commented May 9, 2024

shawnborton commented May 9, 2024

trjExpensify commented May 10, 2024

SzymczakJ commented May 10, 2024 •

edited

Loading

trjExpensify commented May 10, 2024

SzymczakJ commented May 13, 2024

shawnborton commented May 13, 2024

filip-solecki May 14, 2024

filip-solecki May 14, 2024

filip-solecki May 14, 2024

filip-solecki May 14, 2024

filip-solecki May 14, 2024

filip-solecki May 14, 2024

melvin-bot bot commented May 14, 2024

filip-solecki left a comment

fedirjh commented May 15, 2024

OSBotify commented May 15, 2024

OSBotify commented May 15, 2024

Julesssss commented May 16, 2024

hayata-suenaga May 16, 2024

hayata-suenaga commented May 16, 2024

OSBotify commented May 23, 2024

SzymczakJ commented May 23, 2024 •

edited

Loading

hayata-suenaga commented May 23, 2024

	const xeroConfig = policy?.connections?.xero?.config;
	const xeroConfig = policy?.connections?.xero?.config ?? {};

	const isSwitchOn = Boolean(importTrackingCategories);
	const isSwitchOn = !!importTrackingCategories;

Display error messages for Xero Import page #41917

Display error messages for Xero Import page #41917

Conversation

SzymczakJ commented May 9, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

lakchote commented May 9, 2024

shawnborton commented May 9, 2024

lakchote commented May 9, 2024

shawnborton commented May 9, 2024

trjExpensify commented May 10, 2024

SzymczakJ commented May 10, 2024 • edited Loading

trjExpensify commented May 10, 2024

SzymczakJ commented May 13, 2024

shawnborton commented May 13, 2024

filip-solecki May 14, 2024

Choose a reason for hiding this comment

filip-solecki May 14, 2024

Choose a reason for hiding this comment

filip-solecki May 14, 2024

Choose a reason for hiding this comment

filip-solecki May 14, 2024

Choose a reason for hiding this comment

filip-solecki May 14, 2024

Choose a reason for hiding this comment

filip-solecki May 14, 2024

Choose a reason for hiding this comment

melvin-bot bot commented May 14, 2024

filip-solecki left a comment

Choose a reason for hiding this comment

fedirjh commented May 15, 2024

Reviewer Checklist

Screenshots/Videos

OSBotify commented May 15, 2024

OSBotify commented May 15, 2024

Julesssss commented May 16, 2024

hayata-suenaga May 16, 2024

Choose a reason for hiding this comment

hayata-suenaga commented May 16, 2024

OSBotify commented May 23, 2024

SzymczakJ commented May 23, 2024 • edited Loading

hayata-suenaga commented May 23, 2024

SzymczakJ commented May 9, 2024 •

edited

Loading

SzymczakJ commented May 10, 2024 •

edited

Loading

SzymczakJ commented May 23, 2024 •

edited

Loading