[QBD] Handle errors gracefully if the setup link cannot be obtained by hoangzinh · Pull Request #51850 · Expensify/App

hoangzinh · 2024-11-01T11:36:54Z

Explanation of Change

Fixed Issues

$ #51640
PROPOSAL:

Tests

Sign to any account
Go to Settings -> Workspaces
Select a control workspace
Go to Accounting
Override response content of API ConnectPolicyToQuickbooksDesktop command (Tutorial)
Click on the "Connect" button of QBD
Verify it shows "Something went wrong" page
Click on "reach out to Concierge" link
Verify it redirects to the Concierge chat
Do step 2->4 again
Delete override response content in step 5
Disconnect existing connection
Click on the "Connect" button of QBD
Verify it shows the setup link page

Verify that no errors appear in the JS console

Offline tests

Sign to any account
Go to Settings -> Workspaces
Select a control workspace
Go to Accounting
Override response content of API ConnectPolicyToQuickbooksDesktop command (Tutorial)
Click on the "Connect" button of QBD
Verify it shows "Something went wrong" page
Turn off network
Verify it still shows "Something went wrong" page
Turn on network
Verify it still shows "Something went wrong" page

QA Steps

Same as above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

Screen.Recording.2024-11-05.at.17.44.11.mov

MacOS: Desktop

Screen.Recording.2024-11-05.at.17.54.44.mov

hoangzinh · 2024-11-04T10:05:10Z

src/pages/workspace/accounting/qbd/QuickBooksDesktopSetupPage.tsx

+                if (response.jsonCode === CONST.JSON_CODE.SUCCESS) {
+                    setCodatSetupLink(String(response?.setupUrl ?? ''));
+                } else {
+                    setConnectionError(policyID, CONST.POLICY.CONNECTIONS.NAME.QBD, translate('workspace.qbd.setupPage.setupErrorTitle'));


Hi @lakchote I'm expecting that BE also sends connection error via Pusher event in those cases. So we can display error message like this (same thing we used to work here)

Can you confirm if it's correct? IF yes, I will remove those optimistic set error message here (avoid flicker)

Hi @hoangzinh, we do not send via Pusher this error, it is returned instead in the response's body on the PHP side.

Then, I guess I have to set optimistic error here

hoangzinh · 2024-11-05T10:58:44Z

src/languages/es.ts

+                setupErrorTitle: '¡Ups! Ha ocurrido un error',
+                setupErrorBody1: 'La conexión con QuickBooks Desktop no está funcionando en este momento. Por favor, inténtalo de nuevo más tarde o',
+                setupErrorBody2: 'si el problema persiste.',
+                setupErrorBodyContactConcierge: 'contacta con Concierge',


Translation confirmation: https://expensify.slack.com/archives/C01GTK53T8Q/p1730714116839409

melvin-bot · 2024-11-05T10:59:12Z

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

hoangzinh · 2024-11-05T11:00:21Z

@lakchote currently, I have to mock the response body in order to test this PR. If you can give us a test in your local with a real mock BE error response, that would be great.

ZhenjaHorbach · 2024-11-05T14:40:19Z

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

NA

Android: mWeb Chrome

NA

iOS: Native

NA

iOS: mWeb Safari

NA

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

2024-11-06.10.01.35.mov

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

@lakchote currently, I have to mock the response body in order to test this PR. If you can give us a test in your local with a real mock BE error response, that would be great.

You have what is being returned e.g a real response in the related issue. Is that what you meant?

ZhenjaHorbach · 2024-11-05T16:49:33Z

@hoangzinh
Changes look good !
But actually I got a real 666 error from BE

2024-11-05.17.44.09.mov

And I suppose we shouldn't have access to options (import, export, advanced)

ZhenjaHorbach · 2024-11-05T16:57:27Z

src/libs/actions/connections/index.ts

+        connections: {
+            [connectionName]: {
+                lastSync: {
+                    isSuccessful: false,


I think we can add isConnected: false or changeisSuccessful toisConnected here to not show options

App/src/libs/actions/connections/index.ts

Lines 314 to 328 in 955872a

function isConnectionUnverified(policy: OnyxEntry<Policy>, connectionName: PolicyConnectionName): boolean {

// A verified connection is one that has been successfully synced at least once

// We'll always err on the side of considering a connection as verified connected even if we can't find a lastSync property saying as such

// i.e. this is a property that is explicitly set to false, not just missing

if (connectionName === CONST.POLICY.CONNECTIONS.NAME.NETSUITE) {

return !(policy?.connections?.[CONST.POLICY.CONNECTIONS.NAME.NETSUITE]?.verified ?? true);

}

// If the connection has no lastSync property, we'll consider it unverified

if (isEmptyObject(policy?.connections?.[connectionName]?.lastSync)) {

return true;

}

return !(policy?.connections?.[connectionName]?.lastSync?.isConnected ?? true);

}

App/src/pages/workspace/accounting/PolicyAccountingPage.tsx

Line 284 in 955872a

const shouldHideConfigurationOptions = isConnectionUnverified(policy, connectedIntegration);

@ZhenjaHorbach do you mean BE (Pusher event) sent isConnected=true in your case?

No
When we have an error
We don't receive anything

But in case an error we save in Onyx this using setConnectionError

lastSync: { "isSuccessful": false, "errorDate": "2024-11-06T06:20:52.757Z", "errorMessage": "Something went wrong" }

As result we return false here

App/src/libs/actions/connections/index.ts

Lines 314 to 328 in 955872a

function isConnectionUnverified(policy: OnyxEntry<Policy>, connectionName: PolicyConnectionName): boolean {

// A verified connection is one that has been successfully synced at least once

// We'll always err on the side of considering a connection as verified connected even if we can't find a lastSync property saying as such

// i.e. this is a property that is explicitly set to false, not just missing

if (connectionName === CONST.POLICY.CONNECTIONS.NAME.NETSUITE) {

return !(policy?.connections?.[CONST.POLICY.CONNECTIONS.NAME.NETSUITE]?.verified ?? true);

}

// If the connection has no lastSync property, we'll consider it unverified

if (isEmptyObject(policy?.connections?.[connectionName]?.lastSync)) {

return true;

}

return !(policy?.connections?.[connectionName]?.lastSync?.isConnected ?? true);

}

and show options

App/src/pages/workspace/accounting/PolicyAccountingPage.tsx

Line 284 in 955872a

const shouldHideConfigurationOptions = isConnectionUnverified(policy, connectedIntegration);

App/src/pages/workspace/accounting/PolicyAccountingPage.tsx

Line 371 in 955872a

...(isEmptyObject(policy?.connections) || shouldHideConfigurationOptions ? [] : configurationOptions),

For example when we have correct response with setupLink we save "isConnected": false in Onyx and don't show options because shouldHideConfigurationOptions === true

lastSync: { "errorDate": "", "errorMessage": "", "isAuthenticationError": false, "isConnected": false, "isSuccessful": false, "source": "", "successfulDate": "" }

ah I see. Good catch

Updated here 1dc585e

hoangzinh · 2024-11-06T01:40:58Z

@lakchote currently, I have to mock the response body in order to test this PR. If you can give us a test in your local with a real mock BE error response, that would be great.

You have what is being returned e.g a real response in the related issue. Is that what you meant?

@lakchote Not really, I mean, somehow hard-coded 666 error (setup URL not found) in the local BE, to test if it shows correctly in the FE.

hoangzinh · 2024-11-06T01:43:34Z

@hoangzinh Changes look good ! But actually I got a real 666 error from BE

2024-11-05.17.44.09.mov
And I suppose we shouldn't have access to options (import, export, advanced)

@ZhenjaHorbach it's weird. If the syncConnection hasn't been called yet, it won't be showed something like that.

ZhenjaHorbach · 2024-11-06T09:02:40Z

Now everything looks good !

2024-11-06.10.01.35.mov

ZhenjaHorbach · 2024-11-06T09:03:21Z

LGTM !

lakchote · 2024-11-06T09:17:45Z

Tests well too. Thanks @hoangzinh @ZhenjaHorbach.

Screen.Recording.2024-11-06.at.10.17.00.mov

OSBotify · 2024-11-06T09:29:28Z

✋ 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-11-07T13:09:14Z

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

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

github-actions · 2024-11-11T18:14:49Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.59-3 🚀

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

ikevin127 · 2024-12-24T02:01:33Z

src/pages/workspace/accounting/qbd/QuickBooksDesktopSetupPage.tsx

-                {isLoading || !codatSetupLink ? (
-                    <FullScreenLoadingIndicator style={[styles.flex1, styles.pRelative]} />
-                ) : (
+                {shouldShowLoading && <FullScreenLoadingIndicator style={[styles.flex1, styles.pRelative]} />}


Looks like handling loading via FullScreenLoadingIndicator led to this issue:

[HOLD for payment 2024-12-30] [$250] QBD - QBD is displayed like an established connection without error after dismissing the RHP #53608

which we agreed on fixing by showing the setup link UI right away when RHP opens and displaying an ActivityIndicator in the link box while hasResultOfFetchingSetupLink is being fetched.

hoangzinh added 3 commits November 1, 2024 18:14

Handle error gracefully when BE returns error

6cb975c

Implement setup error page

224781c

Optimistic set connection error

57f6848

hoangzinh mentioned this pull request Nov 4, 2024

[HOLD for payment 2024-11-18] [QBD] Handle errors gracefully if the setup link cannot be obtained #51640

Closed

hoangzinh commented Nov 4, 2024

View reviewed changes

hoangzinh added 3 commits November 4, 2024 17:14

Fix auto fetch setup link when go to online even it has error

f8ca901

Merge branch 'main' into 51640-handle-errors-gracefully-qbd-setup-page

720dcb4

Update Spanish for contact concierge

955872a

hoangzinh commented Nov 5, 2024

View reviewed changes

hoangzinh marked this pull request as ready for review November 5, 2024 10:59

hoangzinh requested a review from a team as a code owner November 5, 2024 10:59

melvin-bot bot requested review from ZhenjaHorbach and removed request for a team November 5, 2024 10:59

ZhenjaHorbach reviewed Nov 5, 2024

View reviewed changes

Set isConnected = false when connection error

1dc585e

ZhenjaHorbach approved these changes Nov 6, 2024

View reviewed changes

melvin-bot bot requested a review from lakchote November 6, 2024 09:03

lakchote approved these changes Nov 6, 2024

View reviewed changes

lakchote merged commit 573162f into Expensify:main Nov 6, 2024

github-actions bot mentioned this pull request Nov 7, 2024

Deploy Checklist: New Expensify 2024-11-07 #52178

Closed

60 tasks

ikevin127 reviewed Dec 24, 2024

View reviewed changes

	function isConnectionUnverified(policy: OnyxEntry<Policy>, connectionName: PolicyConnectionName): boolean {
	// A verified connection is one that has been successfully synced at least once
	// We'll always err on the side of considering a connection as verified connected even if we can't find a lastSync property saying as such
	// i.e. this is a property that is explicitly set to false, not just missing
	if (connectionName === CONST.POLICY.CONNECTIONS.NAME.NETSUITE) {
	return !(policy?.connections?.[CONST.POLICY.CONNECTIONS.NAME.NETSUITE]?.verified ?? true);
	}

	// If the connection has no lastSync property, we'll consider it unverified
	if (isEmptyObject(policy?.connections?.[connectionName]?.lastSync)) {
	return true;
	}

	return !(policy?.connections?.[connectionName]?.lastSync?.isConnected ?? true);
	}

Conversation

hoangzinh commented Nov 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Nov 5, 2024

Uh oh!

hoangzinh commented Nov 5, 2024

Uh oh!

ZhenjaHorbach commented Nov 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

lakchote commented Nov 5, 2024

Uh oh!

ZhenjaHorbach commented Nov 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZhenjaHorbach Nov 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ZhenjaHorbach Nov 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hoangzinh commented Nov 6, 2024

Uh oh!

hoangzinh commented Nov 6, 2024

Uh oh!

ZhenjaHorbach commented Nov 6, 2024

Uh oh!

ZhenjaHorbach commented Nov 6, 2024

Uh oh!

lakchote commented Nov 6, 2024

Uh oh!

OSBotify commented Nov 6, 2024

Uh oh!

github-actions bot commented Nov 7, 2024

Uh oh!

github-actions bot commented Nov 11, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hoangzinh commented Nov 1, 2024 •

edited

Loading

ZhenjaHorbach commented Nov 5, 2024 •

edited

Loading

ZhenjaHorbach commented Nov 5, 2024 •

edited

Loading

ZhenjaHorbach Nov 5, 2024 •

edited

Loading

ZhenjaHorbach Nov 6, 2024 •

edited

Loading