Add error message in case of integration sync failure #42307

SzymczakJ · 2024-05-16T16:16:40Z

Details

Fixed Issues

$ #42250
PROPOSAL: N/A

Tests

connect workspace to Xero
go to Xero website to the organization that’s connected to Expensify and then to organization settings

3. disconnect organization from Expensify app

4. click sync now on Expensify Accounting page

Make sure Xero sync error is shown

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

filip-solecki

small comments, generally LGTM

filip-solecki · 2024-05-20T09:01:25Z

src/components/MenuItem.tsx

    /** Hint to display at the bottom of the component */
    hintText?: MaybePhraseKey;

+    /** Should the description be shown above the title (instead of the other way around) */


is the description or variable name correct?

filip-solecki · 2024-05-20T09:04:13Z

src/pages/workspace/accounting/PolicyAccountingPage.tsx

-
+                errorText: hasSynchronizationError(policy, connectedIntegration) ? translate('workspace.accounting.syncError', connectedIntegration) : undefined,
+                errorTextStyle: {marginTop: 8},
+                shouldShowErrorTextRedDot: true,


should it be always true?

In the majority of cases we use this error text without a red dot, so I decided to use shouldShowErrorTextRedDot this way.

…@szymczak/error-message-sync-failure

melvin-bot · 2024-05-20T09:51:07Z

@situchan 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-05-20T15:16:42Z

@francoisl @SzymczakJ tried to make the sync fail by:

changing password of Xero's account
trying to sync again

It should have triggered an error, no?

It seems like we don't validate/refresh the token here

I'm sure there is a reason behind it, so feel free to tell me (I've seen the related issue, but I'd like to know if this is expected or not) 😄

SzymczakJ · 2024-05-20T15:26:46Z

Also this QBO bug is related #42250 (comment)

francoisl · 2024-05-20T18:08:55Z

changing password of Xero's account
trying to sync again
It should have triggered an error, no?

No because the Xero integration uses OAuth, it's independent from your Xero account's password (that's one of the major points of OAuth after all).

If you want to invalidate the OAuth credentials, try to go to https://apps.xero.com/ and then "My Apps" (top right corner) > Connected Apps, then disconnect all the Expensify-DEV entries.

francoisl · 2024-05-20T18:17:57Z

src/languages/en.ts

+                        return "Couldn't connect to QuickBooks Online due to incorrect credentials.";
+                    case CONST.POLICY.CONNECTIONS.NAME.XERO:
+                        return "Couldn't connect to Xero due to incorrect credentials.";
+                    default: {
+                        return "Couldn't connect to integration due to incorrect credentials.";


I don't know if "due to incorrect credentials" is the correct thing to say here. The lastSync.isSuccessful flag is used for any sync error, not just invalid credentials. It could be something like third-party was down, or the user is missing permissions in the third-party for what we're trying to do, etc.

Thank you François for answering quickly my previous question and raising this point!

cc @trjExpensify @zanyrenney in the Xero DD, and in the Figma we would show this Couldn't connect to Xero due to incorrect credentials. message.

But since it can be a lot of completely different things, maybe we need to change it?

Before having this discussion, I suggested to @SzymczakJ using as copy something like Couldn't connect to {integrationName}.. Generic yes, but it fits all the possible use cases. What do you think?

Zany might have more context, but I think this was just an example where incorrect credentials are at fault, but the intention is to pass in the most relevant error we have. Do we not have all of these in OldDot already?

Okay so after investigating, when sync fails, we have error codes (401 and 407) we can use to display a meaningful error message to the user.

See:

Currently on OD, the Xero error message when session has expired is:

xeroConnectFailedMessage: 'Your connection to Xero seems to have expired. Do you want to reconnect now?',

It appears in a modal like below:

We also have dynamic error messages in place (we could reuse the same thought process for QBO):

genericConnectFailedTitle: 'Couldn\'t connect to <%- connectionName %>', genericConnectFailedMessage: 'Your connection to <%- connectionName %> has expired. You can correct this by clicking <b>Reconnect</b> and reauthorizing Expensify with <%- connectionName %>.',

Okay cool, so in this case for NewDot, would the button inside the three dot overflow menu read Enter credentials in this scenario? So our direction would be to point to that instead of a "Reconnect" button?

Looks like we might want to keep it, at least for errors when connecting (not autoSync/export/manual export errors that are out of scope). Especially to demo it at XeroCon.
Thoughts @trjExpensify @arosiclair?

Yeah I think we can keep it though the error we show here should just a generic message like Francois mentioned

Yes, when connecting I agree. 👍

So I should proceed with generic error message like "Couldn't connect to {integration}.", right? @trjExpensify

Yep! This one I believe:

genericConnectFailedTitle: 'Couldn't connect to <%- connectionName %>',

SzymczakJ · 2024-05-21T09:01:09Z

@francoisl do you have any information about QBO? I've described the problem here #42250 (comment)

francoisl · 2024-05-21T18:50:47Z

@francoisl do you have any information about QBO? I've described the problem here #42250 (comment)

Responding in that issue directly.

lakchote · 2024-05-23T15:52:07Z

@Expensify/design can you check it up if it looks good to you?

Thanks!

shawnborton · 2024-05-23T16:46:58Z

For the error message style, I think we actually want something more like this:

Fairly certain these RBR errors should be dismissible, right @trjExpensify ?

As for spacing, we want to use a small 8px gap between the Xero row and the error message:

Let me know if that makes sense, cc @Expensify/design for vis

trjExpensify · 2024-05-23T16:52:53Z

Fairly certain these RBR errors should be dismissible, right @trjExpensify ?

Ah, no. Not this one. This is an integration issue you have to fix to get it working again.

dannymcclain · 2024-05-23T16:53:59Z

Definitely agree about the spacing/styles. Will lean on Tom about dismiss-ability.

shawnborton · 2024-05-23T17:03:32Z

Sweet, thanks for confirming - that gives us this then:

trjExpensify · 2024-05-23T17:43:43Z

Nice!!

rushatgabhane · 2024-05-25T19:06:15Z

@SzymczakJ could you please update the design

…ilure

SzymczakJ · 2024-05-27T09:56:09Z

@rushatgabhane updated styles

SzymczakJ · 2024-05-27T16:06:13Z

@rushatgabhane quick bump 😄

mananjadhav · 2024-05-28T06:51:37Z

src/components/MenuItem.tsx

    /** Hint to display at the bottom of the component */
    hintText?: MaybePhraseKey;

+    /** Should the error text red dot indicator be shown */
+    shouldShowErrorTextRedDot?: boolean;


Why not name this as shouldShowRedDotIndicator? This is consistent across and red dot is generally associated with errors.

mananjadhav · 2024-05-28T06:53:59Z

I’ll review this today.

mananjadhav

Code change looks good to me. I'll test and work on the checklist in a few hours.

mananjadhav · 2024-05-28T15:11:07Z

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

melvin-bot · 2024-05-28T15:11:28Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #42250 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

lakchote · 2024-05-28T15:35:36Z

@Expensify/design could you please give it a final review, with the updated styles?

shawnborton · 2024-05-28T15:37:48Z

Screenshots above look pretty good to me!

OSBotify · 2024-05-30T21:54:38Z

🚀 Deployed to staging by https://github.com/lakchote in version: 1.4.77-11 🚀

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

OSBotify · 2024-05-30T22:31:08Z

🚀 Deployed to staging by https://github.com/lakchote in version: 1.4.77-11 🚀

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

OSBotify · 2024-06-04T13:57:10Z

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

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

SzymczakJ added 4 commits May 16, 2024 18:14

add error message in case of sync failure

68b7551

Merge branch 'main' into @szymczak/error-message-sync-failure

08b321a

add translations

ecdeaf4

delete unrelated changes

e87d711

SzymczakJ changed the base branch from main to xero-merge-freeze May 20, 2024 09:00

filip-solecki approved these changes May 20, 2024

View reviewed changes

SzymczakJ added 2 commits May 20, 2024 11:12

fix PR comments

27972bf

Merge remote-tracking branch 'expensify-real/xero-merge-freeze' into …

de93763

…@szymczak/error-message-sync-failure

SzymczakJ marked this pull request as ready for review May 20, 2024 09:51

SzymczakJ requested a review from a team as a code owner May 20, 2024 09:51

melvin-bot bot requested review from situchan and removed request for a team May 20, 2024 09:51

SzymczakJ mentioned this pull request May 20, 2024

[HOLD for payment 2024-06-11] [Xero][QBO] [Wave Collect] Add error message in case of sync failure #42250

Closed

fix connections lastSync unsafe access

ef5d777

francoisl reviewed May 20, 2024

View reviewed changes

SzymczakJ mentioned this pull request May 21, 2024

[Wave Collect] [Xero] Auto-sync should be enabled by default for all integrations #42375

Closed

change translations

5979a35

lakchote approved these changes May 23, 2024

View reviewed changes

trjExpensify requested review from rushatgabhane and removed request for situchan May 23, 2024 20:25

SzymczakJ added 3 commits May 27, 2024 11:01

Merge branch 'xero-merge-freeze' into @szymczak/error-message-sync-fa…

52216fb

…ilure

fix style

25db9b7

fix styles

b779dff

SzymczakJ added 2 commits May 27, 2024 17:11

fix lint errors

86f509f

fix type error

adddbcd

mananjadhav reviewed May 28, 2024

View reviewed changes

fix PR comments

4ce01d2

mananjadhav reviewed May 28, 2024

View reviewed changes

mananjadhav approved these changes May 28, 2024

View reviewed changes

lakchote merged commit 6604b8f into Expensify:xero-merge-freeze May 28, 2024
15 of 16 checks passed

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

Deploy Checklist: New Expensify 2024-05-30 #42872

Closed

95 tasks

Add error message in case of integration sync failure #42307

Add error message in case of integration sync failure #42307

Conversation

SzymczakJ commented May 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

filip-solecki left a comment

Choose a reason for hiding this comment

filip-solecki May 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented May 20, 2024

lakchote commented May 20, 2024

SzymczakJ commented May 20, 2024

francoisl commented May 20, 2024

Choose a reason for hiding this comment

lakchote May 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lakchote May 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SzymczakJ May 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SzymczakJ commented May 21, 2024

francoisl commented May 21, 2024

lakchote commented May 23, 2024

shawnborton commented May 23, 2024

trjExpensify commented May 23, 2024

dannymcclain commented May 23, 2024

shawnborton commented May 23, 2024 • edited Loading

trjExpensify commented May 23, 2024

rushatgabhane commented May 25, 2024

SzymczakJ commented May 27, 2024

SzymczakJ commented May 27, 2024

Choose a reason for hiding this comment

mananjadhav commented May 28, 2024

mananjadhav left a comment

Choose a reason for hiding this comment

mananjadhav commented May 28, 2024

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented May 28, 2024

lakchote commented May 28, 2024

shawnborton commented May 28, 2024

OSBotify commented May 30, 2024

OSBotify commented May 30, 2024

OSBotify commented Jun 4, 2024

SzymczakJ commented May 16, 2024 •

edited

Loading

filip-solecki May 20, 2024 •

edited

Loading

lakchote May 21, 2024 •

edited

Loading

lakchote May 21, 2024 •

edited

Loading

SzymczakJ May 23, 2024 •

edited

Loading

shawnborton commented May 23, 2024 •

edited

Loading